]> git.ipfire.org Git - people/ms/linux.git/blame - fs/btrfs/lzo.c
btrfs: grab correct extent map for subpage compressed extent read
[people/ms/linux.git] / fs / btrfs / lzo.c
CommitLineData
c1d7c514 1// SPDX-License-Identifier: GPL-2.0
a6fa6fae
LZ
2/*
3 * Copyright (C) 2008 Oracle. All rights reserved.
a6fa6fae
LZ
4 */
5
6#include <linux/kernel.h>
7#include <linux/slab.h>
6acafd1e 8#include <linux/mm.h>
a6fa6fae
LZ
9#include <linux/init.h>
10#include <linux/err.h>
11#include <linux/sched.h>
12#include <linux/pagemap.h>
13#include <linux/bio.h>
14#include <linux/lzo.h>
e1ddce71 15#include <linux/refcount.h>
a6fa6fae
LZ
16#include "compression.h"
17
18#define LZO_LEN 4
19
2a1f7c0c
QW
20/*
21 * Btrfs LZO compression format
22 *
23 * Regular and inlined LZO compressed data extents consist of:
24 *
25 * 1. Header
26 * Fixed size. LZO_LEN (4) bytes long, LE32.
27 * Records the total size (including the header) of compressed data.
28 *
29 * 2. Segment(s)
52042d8e 30 * Variable size. Each segment includes one segment header, followed by data
2a1f7c0c
QW
31 * payload.
32 * One regular LZO compressed extent can have one or more segments.
33 * For inlined LZO compressed extent, only one segment is allowed.
34 * One segment represents at most one page of uncompressed data.
35 *
36 * 2.1 Segment header
37 * Fixed size. LZO_LEN (4) bytes long, LE32.
38 * Records the total size of the segment (not including the header).
39 * Segment header never crosses page boundary, thus it's possible to
40 * have at most 3 padding zeros at the end of the page.
41 *
42 * 2.2 Data Payload
43 * Variable size. Size up limit should be lzo1x_worst_compress(PAGE_SIZE)
44 * which is 4419 for a 4KiB page.
45 *
46 * Example:
47 * Page 1:
48 * 0 0x2 0x4 0x6 0x8 0xa 0xc 0xe 0x10
49 * 0x0000 | Header | SegHdr 01 | Data payload 01 ... |
50 * ...
51 * 0x0ff0 | SegHdr N | Data payload N ... |00|
52 * ^^ padding zeros
53 * Page 2:
54 * 0x1000 | SegHdr N+1| Data payload N+1 ... |
55 */
56
a6fa6fae
LZ
57struct workspace {
58 void *mem;
3fb40375
JL
59 void *buf; /* where decompressed data goes */
60 void *cbuf; /* where compressed data goes */
a6fa6fae
LZ
61 struct list_head list;
62};
63
92ee5530
DZ
64static struct workspace_manager wsm;
65
d20f395f 66void lzo_free_workspace(struct list_head *ws)
a6fa6fae
LZ
67{
68 struct workspace *workspace = list_entry(ws, struct workspace, list);
69
6acafd1e
DS
70 kvfree(workspace->buf);
71 kvfree(workspace->cbuf);
72 kvfree(workspace->mem);
a6fa6fae
LZ
73 kfree(workspace);
74}
75
d20f395f 76struct list_head *lzo_alloc_workspace(unsigned int level)
a6fa6fae
LZ
77{
78 struct workspace *workspace;
79
389a6cfc 80 workspace = kzalloc(sizeof(*workspace), GFP_KERNEL);
a6fa6fae
LZ
81 if (!workspace)
82 return ERR_PTR(-ENOMEM);
83
6acafd1e
DS
84 workspace->mem = kvmalloc(LZO1X_MEM_COMPRESS, GFP_KERNEL);
85 workspace->buf = kvmalloc(lzo1x_worst_compress(PAGE_SIZE), GFP_KERNEL);
86 workspace->cbuf = kvmalloc(lzo1x_worst_compress(PAGE_SIZE), GFP_KERNEL);
a6fa6fae
LZ
87 if (!workspace->mem || !workspace->buf || !workspace->cbuf)
88 goto fail;
89
90 INIT_LIST_HEAD(&workspace->list);
91
92 return &workspace->list;
93fail:
94 lzo_free_workspace(&workspace->list);
95 return ERR_PTR(-ENOMEM);
96}
97
98static inline void write_compress_length(char *buf, size_t len)
99{
100 __le32 dlen;
101
102 dlen = cpu_to_le32(len);
103 memcpy(buf, &dlen, LZO_LEN);
104}
105
14a3357b 106static inline size_t read_compress_length(const char *buf)
a6fa6fae
LZ
107{
108 __le32 dlen;
109
110 memcpy(&dlen, buf, LZO_LEN);
111 return le32_to_cpu(dlen);
112}
113
c4bf665a
DS
114int lzo_compress_pages(struct list_head *ws, struct address_space *mapping,
115 u64 start, struct page **pages, unsigned long *out_pages,
116 unsigned long *total_in, unsigned long *total_out)
a6fa6fae
LZ
117{
118 struct workspace *workspace = list_entry(ws, struct workspace, list);
119 int ret = 0;
120 char *data_in;
58c1a35c 121 char *cpage_out, *sizes_ptr;
a6fa6fae
LZ
122 int nr_pages = 0;
123 struct page *in_page = NULL;
124 struct page *out_page = NULL;
125 unsigned long bytes_left;
38c31464 126 unsigned long len = *total_out;
4d3a800e 127 unsigned long nr_dest_pages = *out_pages;
e5d74902 128 const unsigned long max_out = nr_dest_pages * PAGE_SIZE;
a6fa6fae
LZ
129 size_t in_len;
130 size_t out_len;
131 char *buf;
132 unsigned long tot_in = 0;
133 unsigned long tot_out = 0;
134 unsigned long pg_bytes_left;
135 unsigned long out_offset;
136 unsigned long bytes;
137
138 *out_pages = 0;
139 *total_out = 0;
140 *total_in = 0;
141
09cbfeaf 142 in_page = find_get_page(mapping, start >> PAGE_SHIFT);
8c945d32 143 data_in = page_address(in_page);
a6fa6fae
LZ
144
145 /*
146 * store the size of all chunks of compressed data in
147 * the first 4 bytes
148 */
b0ee5e1e 149 out_page = alloc_page(GFP_NOFS);
a6fa6fae
LZ
150 if (out_page == NULL) {
151 ret = -ENOMEM;
152 goto out;
153 }
8c945d32 154 cpage_out = page_address(out_page);
a6fa6fae
LZ
155 out_offset = LZO_LEN;
156 tot_out = LZO_LEN;
157 pages[0] = out_page;
158 nr_pages = 1;
09cbfeaf 159 pg_bytes_left = PAGE_SIZE - LZO_LEN;
a6fa6fae
LZ
160
161 /* compress at most one page of data each time */
09cbfeaf 162 in_len = min(len, PAGE_SIZE);
a6fa6fae
LZ
163 while (tot_in < len) {
164 ret = lzo1x_1_compress(data_in, in_len, workspace->cbuf,
165 &out_len, workspace->mem);
166 if (ret != LZO_E_OK) {
036b0217 167 pr_debug("BTRFS: lzo in loop returned %d\n",
a6fa6fae 168 ret);
60e1975a 169 ret = -EIO;
a6fa6fae
LZ
170 goto out;
171 }
172
173 /* store the size of this chunk of compressed data */
174 write_compress_length(cpage_out + out_offset, out_len);
175 tot_out += LZO_LEN;
176 out_offset += LZO_LEN;
177 pg_bytes_left -= LZO_LEN;
178
179 tot_in += in_len;
180 tot_out += out_len;
181
182 /* copy bytes from the working buffer into the pages */
183 buf = workspace->cbuf;
184 while (out_len) {
185 bytes = min_t(unsigned long, pg_bytes_left, out_len);
186
187 memcpy(cpage_out + out_offset, buf, bytes);
188
189 out_len -= bytes;
190 pg_bytes_left -= bytes;
191 buf += bytes;
192 out_offset += bytes;
193
194 /*
195 * we need another page for writing out.
196 *
197 * Note if there's less than 4 bytes left, we just
198 * skip to a new page.
199 */
200 if ((out_len == 0 && pg_bytes_left < LZO_LEN) ||
201 pg_bytes_left == 0) {
202 if (pg_bytes_left) {
203 memset(cpage_out + out_offset, 0,
204 pg_bytes_left);
205 tot_out += pg_bytes_left;
206 }
207
208 /* we're done, don't allocate new page */
209 if (out_len == 0 && tot_in >= len)
210 break;
211
a6fa6fae
LZ
212 if (nr_pages == nr_dest_pages) {
213 out_page = NULL;
60e1975a 214 ret = -E2BIG;
a6fa6fae
LZ
215 goto out;
216 }
217
b0ee5e1e 218 out_page = alloc_page(GFP_NOFS);
a6fa6fae
LZ
219 if (out_page == NULL) {
220 ret = -ENOMEM;
221 goto out;
222 }
8c945d32 223 cpage_out = page_address(out_page);
a6fa6fae
LZ
224 pages[nr_pages++] = out_page;
225
09cbfeaf 226 pg_bytes_left = PAGE_SIZE;
a6fa6fae
LZ
227 out_offset = 0;
228 }
229 }
230
231 /* we're making it bigger, give up */
59516f60 232 if (tot_in > 8192 && tot_in < tot_out) {
60e1975a 233 ret = -E2BIG;
a6fa6fae 234 goto out;
59516f60 235 }
a6fa6fae
LZ
236
237 /* we're all done */
238 if (tot_in >= len)
239 break;
240
241 if (tot_out > max_out)
242 break;
243
244 bytes_left = len - tot_in;
09cbfeaf 245 put_page(in_page);
a6fa6fae 246
09cbfeaf
KS
247 start += PAGE_SIZE;
248 in_page = find_get_page(mapping, start >> PAGE_SHIFT);
8c945d32 249 data_in = page_address(in_page);
09cbfeaf 250 in_len = min(bytes_left, PAGE_SIZE);
a6fa6fae
LZ
251 }
252
1e9d7291
TT
253 if (tot_out >= tot_in) {
254 ret = -E2BIG;
a6fa6fae 255 goto out;
1e9d7291 256 }
a6fa6fae
LZ
257
258 /* store the size of all chunks of compressed data */
8c945d32 259 sizes_ptr = page_address(pages[0]);
58c1a35c 260 write_compress_length(sizes_ptr, tot_out);
a6fa6fae
LZ
261
262 ret = 0;
263 *total_out = tot_out;
264 *total_in = tot_in;
265out:
266 *out_pages = nr_pages;
a6fa6fae 267
8c945d32 268 if (in_page)
09cbfeaf 269 put_page(in_page);
a6fa6fae
LZ
270
271 return ret;
272}
273
c4bf665a 274int lzo_decompress_bio(struct list_head *ws, struct compressed_bio *cb)
a6fa6fae
LZ
275{
276 struct workspace *workspace = list_entry(ws, struct workspace, list);
3a39c18d 277 int ret = 0, ret2;
a6fa6fae 278 char *data_in;
a6fa6fae 279 unsigned long page_in_index = 0;
e1ddce71 280 size_t srclen = cb->compressed_len;
09cbfeaf 281 unsigned long total_pages_in = DIV_ROUND_UP(srclen, PAGE_SIZE);
a6fa6fae
LZ
282 unsigned long buf_start;
283 unsigned long buf_offset = 0;
284 unsigned long bytes;
285 unsigned long working_bytes;
a6fa6fae
LZ
286 size_t in_len;
287 size_t out_len;
314bfa47 288 const size_t max_segment_len = lzo1x_worst_compress(PAGE_SIZE);
a6fa6fae
LZ
289 unsigned long in_offset;
290 unsigned long in_page_bytes_left;
291 unsigned long tot_in;
292 unsigned long tot_out;
293 unsigned long tot_len;
294 char *buf;
e1ddce71
AJ
295 struct page **pages_in = cb->compressed_pages;
296 u64 disk_start = cb->start;
297 struct bio *orig_bio = cb->orig_bio;
a6fa6fae 298
8c945d32 299 data_in = page_address(pages_in[0]);
a6fa6fae 300 tot_len = read_compress_length(data_in);
314bfa47
QW
301 /*
302 * Compressed data header check.
303 *
304 * The real compressed size can't exceed the maximum extent length, and
305 * all pages should be used (whole unused page with just the segment
306 * header is not possible). If this happens it means the compressed
307 * extent is corrupted.
308 */
309 if (tot_len > min_t(size_t, BTRFS_MAX_COMPRESSED, srclen) ||
310 tot_len < srclen - PAGE_SIZE) {
311 ret = -EUCLEAN;
312 goto done;
313 }
a6fa6fae
LZ
314
315 tot_in = LZO_LEN;
316 in_offset = LZO_LEN;
09cbfeaf 317 in_page_bytes_left = PAGE_SIZE - LZO_LEN;
a6fa6fae
LZ
318
319 tot_out = 0;
a6fa6fae
LZ
320
321 while (tot_in < tot_len) {
322 in_len = read_compress_length(data_in + in_offset);
323 in_page_bytes_left -= LZO_LEN;
324 in_offset += LZO_LEN;
325 tot_in += LZO_LEN;
326
314bfa47
QW
327 /*
328 * Segment header check.
329 *
330 * The segment length must not exceed the maximum LZO
331 * compression size, nor the total compressed size.
332 */
333 if (in_len > max_segment_len || tot_in + in_len > tot_len) {
334 ret = -EUCLEAN;
335 goto done;
336 }
337
a6fa6fae
LZ
338 tot_in += in_len;
339 working_bytes = in_len;
340
341 /* fast path: avoid using the working buffer */
342 if (in_page_bytes_left >= in_len) {
343 buf = data_in + in_offset;
344 bytes = in_len;
345 goto cont;
346 }
347
348 /* copy bytes from the pages into the working buffer */
349 buf = workspace->cbuf;
350 buf_offset = 0;
351 while (working_bytes) {
352 bytes = min(working_bytes, in_page_bytes_left);
353
354 memcpy(buf + buf_offset, data_in + in_offset, bytes);
355 buf_offset += bytes;
356cont:
357 working_bytes -= bytes;
358 in_page_bytes_left -= bytes;
359 in_offset += bytes;
360
361 /* check if we need to pick another page */
362 if ((working_bytes == 0 && in_page_bytes_left < LZO_LEN)
363 || in_page_bytes_left == 0) {
364 tot_in += in_page_bytes_left;
365
366 if (working_bytes == 0 && tot_in >= tot_len)
367 break;
368
ca9b688c 369 if (page_in_index + 1 >= total_pages_in) {
60e1975a 370 ret = -EIO;
a6fa6fae
LZ
371 goto done;
372 }
ca9b688c 373
8c945d32
DS
374 page_in_index++;
375 data_in = page_address(pages_in[page_in_index]);
a6fa6fae 376
09cbfeaf 377 in_page_bytes_left = PAGE_SIZE;
a6fa6fae
LZ
378 in_offset = 0;
379 }
380 }
381
314bfa47 382 out_len = max_segment_len;
a6fa6fae
LZ
383 ret = lzo1x_decompress_safe(buf, in_len, workspace->buf,
384 &out_len);
385 if (ret != LZO_E_OK) {
62e85577 386 pr_warn("BTRFS: decompress failed\n");
60e1975a 387 ret = -EIO;
a6fa6fae
LZ
388 break;
389 }
390
a6fa6fae 391 buf_start = tot_out;
a6fa6fae
LZ
392 tot_out += out_len;
393
3a39c18d 394 ret2 = btrfs_decompress_buf2page(workspace->buf, buf_start,
974b1adc 395 tot_out, disk_start, orig_bio);
3a39c18d 396 if (ret2 == 0)
a6fa6fae 397 break;
a6fa6fae
LZ
398 }
399done:
2f19cad9 400 if (!ret)
974b1adc 401 zero_fill_bio(orig_bio);
a6fa6fae
LZ
402 return ret;
403}
404
c4bf665a
DS
405int lzo_decompress(struct list_head *ws, unsigned char *data_in,
406 struct page *dest_page, unsigned long start_byte, size_t srclen,
407 size_t destlen)
a6fa6fae
LZ
408{
409 struct workspace *workspace = list_entry(ws, struct workspace, list);
410 size_t in_len;
411 size_t out_len;
de885e3e 412 size_t max_segment_len = lzo1x_worst_compress(PAGE_SIZE);
a6fa6fae
LZ
413 int ret = 0;
414 char *kaddr;
415 unsigned long bytes;
416
de885e3e
QW
417 if (srclen < LZO_LEN || srclen > max_segment_len + LZO_LEN * 2)
418 return -EUCLEAN;
a6fa6fae 419
de885e3e
QW
420 in_len = read_compress_length(data_in);
421 if (in_len != srclen)
422 return -EUCLEAN;
a6fa6fae
LZ
423 data_in += LZO_LEN;
424
425 in_len = read_compress_length(data_in);
de885e3e
QW
426 if (in_len != srclen - LZO_LEN * 2) {
427 ret = -EUCLEAN;
428 goto out;
429 }
a6fa6fae
LZ
430 data_in += LZO_LEN;
431
09cbfeaf 432 out_len = PAGE_SIZE;
a6fa6fae
LZ
433 ret = lzo1x_decompress_safe(data_in, in_len, workspace->buf, &out_len);
434 if (ret != LZO_E_OK) {
62e85577 435 pr_warn("BTRFS: decompress failed!\n");
60e1975a 436 ret = -EIO;
a6fa6fae
LZ
437 goto out;
438 }
439
440 if (out_len < start_byte) {
60e1975a 441 ret = -EIO;
a6fa6fae
LZ
442 goto out;
443 }
444
2f19cad9
CM
445 /*
446 * the caller is already checking against PAGE_SIZE, but lets
447 * move this check closer to the memcpy/memset
448 */
449 destlen = min_t(unsigned long, destlen, PAGE_SIZE);
a6fa6fae
LZ
450 bytes = min_t(unsigned long, destlen, out_len - start_byte);
451
8c945d32 452 kaddr = page_address(dest_page);
a6fa6fae 453 memcpy(kaddr, workspace->buf + start_byte, bytes);
2f19cad9
CM
454
455 /*
456 * btrfs_getblock is doing a zero on the tail of the page too,
457 * but this will cover anything missing from the decompressed
458 * data.
459 */
460 if (bytes < destlen)
461 memset(kaddr+bytes, 0, destlen-bytes);
a6fa6fae
LZ
462out:
463 return ret;
464}
465
e8c9f186 466const struct btrfs_compress_op btrfs_lzo_compress = {
be951045 467 .workspace_manager = &wsm,
e18333a7
DS
468 .max_level = 1,
469 .default_level = 1,
a6fa6fae 470};