1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Squashfs - a compressed read only filesystem for Linux
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Copyright (c) 2016-present, Facebook, Inc.
6*4882a593Smuzhiyun * All rights reserved.
7*4882a593Smuzhiyun *
8*4882a593Smuzhiyun * zstd_wrapper.c
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun
11*4882a593Smuzhiyun #include <linux/mutex.h>
12*4882a593Smuzhiyun #include <linux/bio.h>
13*4882a593Smuzhiyun #include <linux/slab.h>
14*4882a593Smuzhiyun #include <linux/zstd.h>
15*4882a593Smuzhiyun #include <linux/vmalloc.h>
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun #include "squashfs_fs.h"
18*4882a593Smuzhiyun #include "squashfs_fs_sb.h"
19*4882a593Smuzhiyun #include "squashfs.h"
20*4882a593Smuzhiyun #include "decompressor.h"
21*4882a593Smuzhiyun #include "page_actor.h"
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun struct workspace {
24*4882a593Smuzhiyun void *mem;
25*4882a593Smuzhiyun size_t mem_size;
26*4882a593Smuzhiyun size_t window_size;
27*4882a593Smuzhiyun };
28*4882a593Smuzhiyun
zstd_init(struct squashfs_sb_info * msblk,void * buff)29*4882a593Smuzhiyun static void *zstd_init(struct squashfs_sb_info *msblk, void *buff)
30*4882a593Smuzhiyun {
31*4882a593Smuzhiyun struct workspace *wksp = kmalloc(sizeof(*wksp), GFP_KERNEL);
32*4882a593Smuzhiyun
33*4882a593Smuzhiyun if (wksp == NULL)
34*4882a593Smuzhiyun goto failed;
35*4882a593Smuzhiyun wksp->window_size = max_t(size_t,
36*4882a593Smuzhiyun msblk->block_size, SQUASHFS_METADATA_SIZE);
37*4882a593Smuzhiyun wksp->mem_size = ZSTD_DStreamWorkspaceBound(wksp->window_size);
38*4882a593Smuzhiyun wksp->mem = vmalloc(wksp->mem_size);
39*4882a593Smuzhiyun if (wksp->mem == NULL)
40*4882a593Smuzhiyun goto failed;
41*4882a593Smuzhiyun
42*4882a593Smuzhiyun return wksp;
43*4882a593Smuzhiyun
44*4882a593Smuzhiyun failed:
45*4882a593Smuzhiyun ERROR("Failed to allocate zstd workspace\n");
46*4882a593Smuzhiyun kfree(wksp);
47*4882a593Smuzhiyun return ERR_PTR(-ENOMEM);
48*4882a593Smuzhiyun }
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun
zstd_free(void * strm)51*4882a593Smuzhiyun static void zstd_free(void *strm)
52*4882a593Smuzhiyun {
53*4882a593Smuzhiyun struct workspace *wksp = strm;
54*4882a593Smuzhiyun
55*4882a593Smuzhiyun if (wksp)
56*4882a593Smuzhiyun vfree(wksp->mem);
57*4882a593Smuzhiyun kfree(wksp);
58*4882a593Smuzhiyun }
59*4882a593Smuzhiyun
60*4882a593Smuzhiyun
zstd_uncompress(struct squashfs_sb_info * msblk,void * strm,struct bio * bio,int offset,int length,struct squashfs_page_actor * output)61*4882a593Smuzhiyun static int zstd_uncompress(struct squashfs_sb_info *msblk, void *strm,
62*4882a593Smuzhiyun struct bio *bio, int offset, int length,
63*4882a593Smuzhiyun struct squashfs_page_actor *output)
64*4882a593Smuzhiyun {
65*4882a593Smuzhiyun struct workspace *wksp = strm;
66*4882a593Smuzhiyun ZSTD_DStream *stream;
67*4882a593Smuzhiyun size_t total_out = 0;
68*4882a593Smuzhiyun int error = 0;
69*4882a593Smuzhiyun ZSTD_inBuffer in_buf = { NULL, 0, 0 };
70*4882a593Smuzhiyun ZSTD_outBuffer out_buf = { NULL, 0, 0 };
71*4882a593Smuzhiyun struct bvec_iter_all iter_all = {};
72*4882a593Smuzhiyun struct bio_vec *bvec = bvec_init_iter_all(&iter_all);
73*4882a593Smuzhiyun
74*4882a593Smuzhiyun stream = ZSTD_initDStream(wksp->window_size, wksp->mem, wksp->mem_size);
75*4882a593Smuzhiyun
76*4882a593Smuzhiyun if (!stream) {
77*4882a593Smuzhiyun ERROR("Failed to initialize zstd decompressor\n");
78*4882a593Smuzhiyun return -EIO;
79*4882a593Smuzhiyun }
80*4882a593Smuzhiyun
81*4882a593Smuzhiyun out_buf.size = PAGE_SIZE;
82*4882a593Smuzhiyun out_buf.dst = squashfs_first_page(output);
83*4882a593Smuzhiyun
84*4882a593Smuzhiyun for (;;) {
85*4882a593Smuzhiyun size_t zstd_err;
86*4882a593Smuzhiyun
87*4882a593Smuzhiyun if (in_buf.pos == in_buf.size) {
88*4882a593Smuzhiyun const void *data;
89*4882a593Smuzhiyun int avail;
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun if (!bio_next_segment(bio, &iter_all)) {
92*4882a593Smuzhiyun error = -EIO;
93*4882a593Smuzhiyun break;
94*4882a593Smuzhiyun }
95*4882a593Smuzhiyun
96*4882a593Smuzhiyun avail = min(length, ((int)bvec->bv_len) - offset);
97*4882a593Smuzhiyun data = page_address(bvec->bv_page) + bvec->bv_offset;
98*4882a593Smuzhiyun length -= avail;
99*4882a593Smuzhiyun in_buf.src = data + offset;
100*4882a593Smuzhiyun in_buf.size = avail;
101*4882a593Smuzhiyun in_buf.pos = 0;
102*4882a593Smuzhiyun offset = 0;
103*4882a593Smuzhiyun }
104*4882a593Smuzhiyun
105*4882a593Smuzhiyun if (out_buf.pos == out_buf.size) {
106*4882a593Smuzhiyun out_buf.dst = squashfs_next_page(output);
107*4882a593Smuzhiyun if (out_buf.dst == NULL) {
108*4882a593Smuzhiyun /* Shouldn't run out of pages
109*4882a593Smuzhiyun * before stream is done.
110*4882a593Smuzhiyun */
111*4882a593Smuzhiyun error = -EIO;
112*4882a593Smuzhiyun break;
113*4882a593Smuzhiyun }
114*4882a593Smuzhiyun out_buf.pos = 0;
115*4882a593Smuzhiyun out_buf.size = PAGE_SIZE;
116*4882a593Smuzhiyun }
117*4882a593Smuzhiyun
118*4882a593Smuzhiyun total_out -= out_buf.pos;
119*4882a593Smuzhiyun zstd_err = ZSTD_decompressStream(stream, &out_buf, &in_buf);
120*4882a593Smuzhiyun total_out += out_buf.pos; /* add the additional data produced */
121*4882a593Smuzhiyun if (zstd_err == 0)
122*4882a593Smuzhiyun break;
123*4882a593Smuzhiyun
124*4882a593Smuzhiyun if (ZSTD_isError(zstd_err)) {
125*4882a593Smuzhiyun ERROR("zstd decompression error: %d\n",
126*4882a593Smuzhiyun (int)ZSTD_getErrorCode(zstd_err));
127*4882a593Smuzhiyun error = -EIO;
128*4882a593Smuzhiyun break;
129*4882a593Smuzhiyun }
130*4882a593Smuzhiyun }
131*4882a593Smuzhiyun
132*4882a593Smuzhiyun squashfs_finish_page(output);
133*4882a593Smuzhiyun
134*4882a593Smuzhiyun return error ? error : total_out;
135*4882a593Smuzhiyun }
136*4882a593Smuzhiyun
137*4882a593Smuzhiyun const struct squashfs_decompressor squashfs_zstd_comp_ops = {
138*4882a593Smuzhiyun .init = zstd_init,
139*4882a593Smuzhiyun .free = zstd_free,
140*4882a593Smuzhiyun .decompress = zstd_uncompress,
141*4882a593Smuzhiyun .id = ZSTD_COMPRESSION,
142*4882a593Smuzhiyun .name = "zstd",
143*4882a593Smuzhiyun .supported = 1
144*4882a593Smuzhiyun };
145