]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - fs/btrfs/zlib.c
Merge git://git.kernel.org/pub/scm/linux/kernel/git/netdev/net
[mirror_ubuntu-hirsute-kernel.git] / fs / btrfs / zlib.c
CommitLineData
c1d7c514 1// SPDX-License-Identifier: GPL-2.0
c8b97818
CM
2/*
3 * Copyright (C) 2008 Oracle. All rights reserved.
4 *
c8b97818
CM
5 * Based on jffs2 zlib code:
6 * Copyright © 2001-2007 Red Hat, Inc.
7 * Created by David Woodhouse <dwmw2@infradead.org>
8 */
9
10#include <linux/kernel.h>
11#include <linux/slab.h>
12#include <linux/zlib.h>
13#include <linux/zutil.h>
6acafd1e 14#include <linux/mm.h>
c8b97818
CM
15#include <linux/init.h>
16#include <linux/err.h>
17#include <linux/sched.h>
18#include <linux/pagemap.h>
19#include <linux/bio.h>
e1ddce71 20#include <linux/refcount.h>
b2950863 21#include "compression.h"
c8b97818 22
3fd396af
MZ
23/* workspace buffer size for s390 zlib hardware support */
24#define ZLIB_DFLTCC_BUF_SIZE (4 * PAGE_SIZE)
25
c8b97818 26struct workspace {
78809913 27 z_stream strm;
c8b97818 28 char *buf;
3fd396af 29 unsigned int buf_size;
c8b97818 30 struct list_head list;
f51d2b59 31 int level;
c8b97818
CM
32};
33
92ee5530
DZ
34static struct workspace_manager wsm;
35
d20f395f 36struct list_head *zlib_get_workspace(unsigned int level)
92ee5530 37{
5907a9bb 38 struct list_head *ws = btrfs_get_workspace(BTRFS_COMPRESS_ZLIB, level);
d0ab62ce
DZ
39 struct workspace *workspace = list_entry(ws, struct workspace, list);
40
41 workspace->level = level;
42
43 return ws;
92ee5530
DZ
44}
45
d20f395f 46void zlib_free_workspace(struct list_head *ws)
261507a0
LZ
47{
48 struct workspace *workspace = list_entry(ws, struct workspace, list);
c8b97818 49
6acafd1e 50 kvfree(workspace->strm.workspace);
261507a0
LZ
51 kfree(workspace->buf);
52 kfree(workspace);
53}
54
d20f395f 55struct list_head *zlib_alloc_workspace(unsigned int level)
c8b97818
CM
56{
57 struct workspace *workspace;
78809913 58 int workspacesize;
8844355d 59
389a6cfc 60 workspace = kzalloc(sizeof(*workspace), GFP_KERNEL);
261507a0
LZ
61 if (!workspace)
62 return ERR_PTR(-ENOMEM);
c8b97818 63
78809913
SS
64 workspacesize = max(zlib_deflate_workspacesize(MAX_WBITS, MAX_MEM_LEVEL),
65 zlib_inflate_workspacesize());
6acafd1e 66 workspace->strm.workspace = kvmalloc(workspacesize, GFP_KERNEL);
7bf49943 67 workspace->level = level;
3fd396af
MZ
68 workspace->buf = NULL;
69 /*
70 * In case of s390 zlib hardware support, allocate lager workspace
71 * buffer. If allocator fails, fall back to a single page buffer.
72 */
73 if (zlib_deflate_dfltcc_enabled()) {
74 workspace->buf = kmalloc(ZLIB_DFLTCC_BUF_SIZE,
75 __GFP_NOMEMALLOC | __GFP_NORETRY |
76 __GFP_NOWARN | GFP_NOIO);
77 workspace->buf_size = ZLIB_DFLTCC_BUF_SIZE;
78 }
79 if (!workspace->buf) {
80 workspace->buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
81 workspace->buf_size = PAGE_SIZE;
82 }
78809913 83 if (!workspace->strm.workspace || !workspace->buf)
261507a0 84 goto fail;
c8b97818 85
261507a0 86 INIT_LIST_HEAD(&workspace->list);
c8b97818 87
261507a0
LZ
88 return &workspace->list;
89fail:
90 zlib_free_workspace(&workspace->list);
91 return ERR_PTR(-ENOMEM);
c8b97818
CM
92}
93
c4bf665a
DS
94int zlib_compress_pages(struct list_head *ws, struct address_space *mapping,
95 u64 start, struct page **pages, unsigned long *out_pages,
96 unsigned long *total_in, unsigned long *total_out)
c8b97818 97{
261507a0 98 struct workspace *workspace = list_entry(ws, struct workspace, list);
c8b97818 99 int ret;
c8b97818
CM
100 char *data_in;
101 char *cpage_out;
102 int nr_pages = 0;
103 struct page *in_page = NULL;
104 struct page *out_page = NULL;
c8b97818 105 unsigned long bytes_left;
3fd396af 106 unsigned int in_buf_pages;
38c31464 107 unsigned long len = *total_out;
4d3a800e 108 unsigned long nr_dest_pages = *out_pages;
e5d74902 109 const unsigned long max_out = nr_dest_pages * PAGE_SIZE;
c8b97818
CM
110
111 *out_pages = 0;
112 *total_out = 0;
113 *total_in = 0;
114
f51d2b59 115 if (Z_OK != zlib_deflateInit(&workspace->strm, workspace->level)) {
62e85577 116 pr_warn("BTRFS: deflateInit failed\n");
60e1975a 117 ret = -EIO;
c8b97818
CM
118 goto out;
119 }
120
78809913
SS
121 workspace->strm.total_in = 0;
122 workspace->strm.total_out = 0;
c8b97818 123
c8b97818 124 out_page = alloc_page(GFP_NOFS | __GFP_HIGHMEM);
4b72029d 125 if (out_page == NULL) {
60e1975a 126 ret = -ENOMEM;
4b72029d
LZ
127 goto out;
128 }
c8b97818
CM
129 cpage_out = kmap(out_page);
130 pages[0] = out_page;
131 nr_pages = 1;
132
3fd396af
MZ
133 workspace->strm.next_in = workspace->buf;
134 workspace->strm.avail_in = 0;
78809913 135 workspace->strm.next_out = cpage_out;
09cbfeaf 136 workspace->strm.avail_out = PAGE_SIZE;
c8b97818 137
78809913 138 while (workspace->strm.total_in < len) {
3fd396af
MZ
139 /*
140 * Get next input pages and copy the contents to
141 * the workspace buffer if required.
142 */
143 if (workspace->strm.avail_in == 0) {
144 bytes_left = len - workspace->strm.total_in;
145 in_buf_pages = min(DIV_ROUND_UP(bytes_left, PAGE_SIZE),
146 workspace->buf_size / PAGE_SIZE);
147 if (in_buf_pages > 1) {
148 int i;
149
150 for (i = 0; i < in_buf_pages; i++) {
151 if (in_page) {
152 kunmap(in_page);
153 put_page(in_page);
154 }
155 in_page = find_get_page(mapping,
156 start >> PAGE_SHIFT);
157 data_in = kmap(in_page);
158 memcpy(workspace->buf + i * PAGE_SIZE,
159 data_in, PAGE_SIZE);
160 start += PAGE_SIZE;
161 }
162 workspace->strm.next_in = workspace->buf;
163 } else {
164 if (in_page) {
165 kunmap(in_page);
166 put_page(in_page);
167 }
168 in_page = find_get_page(mapping,
169 start >> PAGE_SHIFT);
170 data_in = kmap(in_page);
171 start += PAGE_SIZE;
172 workspace->strm.next_in = data_in;
173 }
174 workspace->strm.avail_in = min(bytes_left,
175 (unsigned long) workspace->buf_size);
176 }
177
78809913 178 ret = zlib_deflate(&workspace->strm, Z_SYNC_FLUSH);
c8b97818 179 if (ret != Z_OK) {
62e85577 180 pr_debug("BTRFS: deflate in loop returned %d\n",
c8b97818 181 ret);
78809913 182 zlib_deflateEnd(&workspace->strm);
60e1975a 183 ret = -EIO;
c8b97818
CM
184 goto out;
185 }
186
187 /* we're making it bigger, give up */
78809913
SS
188 if (workspace->strm.total_in > 8192 &&
189 workspace->strm.total_in <
190 workspace->strm.total_out) {
130d5b41 191 ret = -E2BIG;
c8b97818
CM
192 goto out;
193 }
194 /* we need another page for writing out. Test this
195 * before the total_in so we will pull in a new page for
196 * the stream end if required
197 */
78809913 198 if (workspace->strm.avail_out == 0) {
c8b97818
CM
199 kunmap(out_page);
200 if (nr_pages == nr_dest_pages) {
201 out_page = NULL;
60e1975a 202 ret = -E2BIG;
c8b97818
CM
203 goto out;
204 }
205 out_page = alloc_page(GFP_NOFS | __GFP_HIGHMEM);
4b72029d 206 if (out_page == NULL) {
60e1975a 207 ret = -ENOMEM;
4b72029d
LZ
208 goto out;
209 }
c8b97818
CM
210 cpage_out = kmap(out_page);
211 pages[nr_pages] = out_page;
212 nr_pages++;
09cbfeaf 213 workspace->strm.avail_out = PAGE_SIZE;
78809913 214 workspace->strm.next_out = cpage_out;
c8b97818
CM
215 }
216 /* we're all done */
78809913 217 if (workspace->strm.total_in >= len)
c8b97818 218 break;
3fd396af
MZ
219 if (workspace->strm.total_out > max_out)
220 break;
c8b97818 221 }
78809913 222 workspace->strm.avail_in = 0;
3fd396af
MZ
223 /*
224 * Call deflate with Z_FINISH flush parameter providing more output
225 * space but no more input data, until it returns with Z_STREAM_END.
226 */
227 while (ret != Z_STREAM_END) {
228 ret = zlib_deflate(&workspace->strm, Z_FINISH);
229 if (ret == Z_STREAM_END)
230 break;
231 if (ret != Z_OK && ret != Z_BUF_ERROR) {
232 zlib_deflateEnd(&workspace->strm);
233 ret = -EIO;
234 goto out;
235 } else if (workspace->strm.avail_out == 0) {
236 /* get another page for the stream end */
237 kunmap(out_page);
238 if (nr_pages == nr_dest_pages) {
239 out_page = NULL;
240 ret = -E2BIG;
241 goto out;
242 }
243 out_page = alloc_page(GFP_NOFS | __GFP_HIGHMEM);
244 if (out_page == NULL) {
245 ret = -ENOMEM;
246 goto out;
247 }
248 cpage_out = kmap(out_page);
249 pages[nr_pages] = out_page;
250 nr_pages++;
251 workspace->strm.avail_out = PAGE_SIZE;
252 workspace->strm.next_out = cpage_out;
253 }
c8b97818 254 }
3fd396af 255 zlib_deflateEnd(&workspace->strm);
c8b97818 256
78809913 257 if (workspace->strm.total_out >= workspace->strm.total_in) {
60e1975a 258 ret = -E2BIG;
c8b97818
CM
259 goto out;
260 }
261
262 ret = 0;
78809913
SS
263 *total_out = workspace->strm.total_out;
264 *total_in = workspace->strm.total_in;
c8b97818
CM
265out:
266 *out_pages = nr_pages;
267 if (out_page)
268 kunmap(out_page);
269
270 if (in_page) {
271 kunmap(in_page);
09cbfeaf 272 put_page(in_page);
c8b97818 273 }
c8b97818
CM
274 return ret;
275}
276
c4bf665a 277int zlib_decompress_bio(struct list_head *ws, struct compressed_bio *cb)
c8b97818 278{
261507a0 279 struct workspace *workspace = list_entry(ws, struct workspace, list);
3a39c18d 280 int ret = 0, ret2;
c8b97818 281 int wbits = MAX_WBITS;
c8b97818
CM
282 char *data_in;
283 size_t total_out = 0;
c8b97818 284 unsigned long page_in_index = 0;
e1ddce71 285 size_t srclen = cb->compressed_len;
09cbfeaf 286 unsigned long total_pages_in = DIV_ROUND_UP(srclen, PAGE_SIZE);
c8b97818 287 unsigned long buf_start;
e1ddce71
AJ
288 struct page **pages_in = cb->compressed_pages;
289 u64 disk_start = cb->start;
290 struct bio *orig_bio = cb->orig_bio;
c8b97818 291
c8b97818 292 data_in = kmap(pages_in[page_in_index]);
78809913 293 workspace->strm.next_in = data_in;
09cbfeaf 294 workspace->strm.avail_in = min_t(size_t, srclen, PAGE_SIZE);
78809913 295 workspace->strm.total_in = 0;
c8b97818 296
78809913
SS
297 workspace->strm.total_out = 0;
298 workspace->strm.next_out = workspace->buf;
3fd396af 299 workspace->strm.avail_out = workspace->buf_size;
c8b97818
CM
300
301 /* If it's deflate, and it's got no preset dictionary, then
302 we can tell zlib to skip the adler32 check. */
303 if (srclen > 2 && !(data_in[1] & PRESET_DICT) &&
304 ((data_in[0] & 0x0f) == Z_DEFLATED) &&
305 !(((data_in[0]<<8) + data_in[1]) % 31)) {
306
307 wbits = -((data_in[0] >> 4) + 8);
78809913
SS
308 workspace->strm.next_in += 2;
309 workspace->strm.avail_in -= 2;
c8b97818
CM
310 }
311
78809913 312 if (Z_OK != zlib_inflateInit2(&workspace->strm, wbits)) {
62e85577 313 pr_warn("BTRFS: inflateInit failed\n");
d1111a75 314 kunmap(pages_in[page_in_index]);
60e1975a 315 return -EIO;
c8b97818 316 }
78809913
SS
317 while (workspace->strm.total_in < srclen) {
318 ret = zlib_inflate(&workspace->strm, Z_NO_FLUSH);
d397712b 319 if (ret != Z_OK && ret != Z_STREAM_END)
c8b97818 320 break;
c8b97818 321
3a39c18d 322 buf_start = total_out;
78809913 323 total_out = workspace->strm.total_out;
c8b97818 324
3a39c18d
LZ
325 /* we didn't make progress in this inflate call, we're done */
326 if (buf_start == total_out)
c8b97818 327 break;
c8b97818 328
3a39c18d
LZ
329 ret2 = btrfs_decompress_buf2page(workspace->buf, buf_start,
330 total_out, disk_start,
974b1adc 331 orig_bio);
3a39c18d
LZ
332 if (ret2 == 0) {
333 ret = 0;
334 goto done;
c8b97818 335 }
3a39c18d 336
78809913 337 workspace->strm.next_out = workspace->buf;
3fd396af 338 workspace->strm.avail_out = workspace->buf_size;
c8b97818 339
78809913 340 if (workspace->strm.avail_in == 0) {
c8b97818
CM
341 unsigned long tmp;
342 kunmap(pages_in[page_in_index]);
343 page_in_index++;
344 if (page_in_index >= total_pages_in) {
345 data_in = NULL;
346 break;
347 }
348 data_in = kmap(pages_in[page_in_index]);
78809913
SS
349 workspace->strm.next_in = data_in;
350 tmp = srclen - workspace->strm.total_in;
351 workspace->strm.avail_in = min(tmp,
09cbfeaf 352 PAGE_SIZE);
c8b97818
CM
353 }
354 }
d397712b 355 if (ret != Z_STREAM_END)
60e1975a 356 ret = -EIO;
d397712b 357 else
c8b97818 358 ret = 0;
c8b97818 359done:
78809913 360 zlib_inflateEnd(&workspace->strm);
c8b97818
CM
361 if (data_in)
362 kunmap(pages_in[page_in_index]);
2f19cad9 363 if (!ret)
974b1adc 364 zero_fill_bio(orig_bio);
c8b97818
CM
365 return ret;
366}
367
c4bf665a
DS
368int zlib_decompress(struct list_head *ws, unsigned char *data_in,
369 struct page *dest_page, unsigned long start_byte, size_t srclen,
370 size_t destlen)
c8b97818 371{
261507a0 372 struct workspace *workspace = list_entry(ws, struct workspace, list);
c8b97818
CM
373 int ret = 0;
374 int wbits = MAX_WBITS;
2f19cad9 375 unsigned long bytes_left;
c8b97818 376 unsigned long total_out = 0;
2f19cad9 377 unsigned long pg_offset = 0;
c8b97818
CM
378 char *kaddr;
379
2f19cad9
CM
380 destlen = min_t(unsigned long, destlen, PAGE_SIZE);
381 bytes_left = destlen;
382
78809913
SS
383 workspace->strm.next_in = data_in;
384 workspace->strm.avail_in = srclen;
385 workspace->strm.total_in = 0;
c8b97818 386
78809913 387 workspace->strm.next_out = workspace->buf;
3fd396af 388 workspace->strm.avail_out = workspace->buf_size;
78809913 389 workspace->strm.total_out = 0;
c8b97818
CM
390 /* If it's deflate, and it's got no preset dictionary, then
391 we can tell zlib to skip the adler32 check. */
392 if (srclen > 2 && !(data_in[1] & PRESET_DICT) &&
393 ((data_in[0] & 0x0f) == Z_DEFLATED) &&
394 !(((data_in[0]<<8) + data_in[1]) % 31)) {
395
396 wbits = -((data_in[0] >> 4) + 8);
78809913
SS
397 workspace->strm.next_in += 2;
398 workspace->strm.avail_in -= 2;
c8b97818
CM
399 }
400
78809913 401 if (Z_OK != zlib_inflateInit2(&workspace->strm, wbits)) {
62e85577 402 pr_warn("BTRFS: inflateInit failed\n");
60e1975a 403 return -EIO;
c8b97818
CM
404 }
405
d397712b 406 while (bytes_left > 0) {
c8b97818
CM
407 unsigned long buf_start;
408 unsigned long buf_offset;
409 unsigned long bytes;
c8b97818 410
78809913 411 ret = zlib_inflate(&workspace->strm, Z_NO_FLUSH);
d397712b 412 if (ret != Z_OK && ret != Z_STREAM_END)
c8b97818 413 break;
c8b97818
CM
414
415 buf_start = total_out;
78809913 416 total_out = workspace->strm.total_out;
c8b97818
CM
417
418 if (total_out == buf_start) {
60e1975a 419 ret = -EIO;
c8b97818
CM
420 break;
421 }
422
d397712b 423 if (total_out <= start_byte)
c8b97818 424 goto next;
c8b97818 425
d397712b 426 if (total_out > start_byte && buf_start < start_byte)
c8b97818 427 buf_offset = start_byte - buf_start;
d397712b 428 else
c8b97818 429 buf_offset = 0;
c8b97818 430
09cbfeaf 431 bytes = min(PAGE_SIZE - pg_offset,
3fd396af 432 PAGE_SIZE - (buf_offset % PAGE_SIZE));
c8b97818
CM
433 bytes = min(bytes, bytes_left);
434
7ac687d9 435 kaddr = kmap_atomic(dest_page);
c8b97818 436 memcpy(kaddr + pg_offset, workspace->buf + buf_offset, bytes);
7ac687d9 437 kunmap_atomic(kaddr);
c8b97818
CM
438
439 pg_offset += bytes;
440 bytes_left -= bytes;
441next:
78809913 442 workspace->strm.next_out = workspace->buf;
3fd396af 443 workspace->strm.avail_out = workspace->buf_size;
c8b97818 444 }
d397712b
CM
445
446 if (ret != Z_STREAM_END && bytes_left != 0)
60e1975a 447 ret = -EIO;
d397712b 448 else
c8b97818 449 ret = 0;
d397712b 450
78809913 451 zlib_inflateEnd(&workspace->strm);
2f19cad9
CM
452
453 /*
454 * this should only happen if zlib returned fewer bytes than we
455 * expected. btrfs_get_block is responsible for zeroing from the
456 * end of the inline extent (destlen) to the end of the page
457 */
458 if (pg_offset < destlen) {
459 kaddr = kmap_atomic(dest_page);
460 memset(kaddr + pg_offset, 0, destlen - pg_offset);
461 kunmap_atomic(kaddr);
462 }
c8b97818
CM
463 return ret;
464}
465
e8c9f186 466const struct btrfs_compress_op btrfs_zlib_compress = {
be951045 467 .workspace_manager = &wsm,
e18333a7
DS
468 .max_level = 9,
469 .default_level = BTRFS_ZLIB_DEFAULT_LEVEL,
261507a0 470};