f48794a360689d97568754ed2d44a535b8ea925e
[sfrench/cifs-2.6.git] / fs / btrfs / compression.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) 2008 Oracle.  All rights reserved.
4  */
5
6 #include <linux/kernel.h>
7 #include <linux/bio.h>
8 #include <linux/file.h>
9 #include <linux/fs.h>
10 #include <linux/pagemap.h>
11 #include <linux/highmem.h>
12 #include <linux/time.h>
13 #include <linux/init.h>
14 #include <linux/string.h>
15 #include <linux/backing-dev.h>
16 #include <linux/writeback.h>
17 #include <linux/slab.h>
18 #include <linux/sched/mm.h>
19 #include <linux/log2.h>
20 #include "ctree.h"
21 #include "disk-io.h"
22 #include "transaction.h"
23 #include "btrfs_inode.h"
24 #include "volumes.h"
25 #include "ordered-data.h"
26 #include "compression.h"
27 #include "extent_io.h"
28 #include "extent_map.h"
29
30 static const char* const btrfs_compress_types[] = { "", "zlib", "lzo", "zstd" };
31
32 const char* btrfs_compress_type2str(enum btrfs_compression_type type)
33 {
34         switch (type) {
35         case BTRFS_COMPRESS_ZLIB:
36         case BTRFS_COMPRESS_LZO:
37         case BTRFS_COMPRESS_ZSTD:
38         case BTRFS_COMPRESS_NONE:
39                 return btrfs_compress_types[type];
40         }
41
42         return NULL;
43 }
44
45 static int btrfs_decompress_bio(struct compressed_bio *cb);
46
47 static inline int compressed_bio_size(struct btrfs_fs_info *fs_info,
48                                       unsigned long disk_size)
49 {
50         u16 csum_size = btrfs_super_csum_size(fs_info->super_copy);
51
52         return sizeof(struct compressed_bio) +
53                 (DIV_ROUND_UP(disk_size, fs_info->sectorsize)) * csum_size;
54 }
55
56 static int check_compressed_csum(struct btrfs_inode *inode,
57                                  struct compressed_bio *cb,
58                                  u64 disk_start)
59 {
60         int ret;
61         struct page *page;
62         unsigned long i;
63         char *kaddr;
64         u32 csum;
65         u32 *cb_sum = &cb->sums;
66
67         if (inode->flags & BTRFS_INODE_NODATASUM)
68                 return 0;
69
70         for (i = 0; i < cb->nr_pages; i++) {
71                 page = cb->compressed_pages[i];
72                 csum = ~(u32)0;
73
74                 kaddr = kmap_atomic(page);
75                 csum = btrfs_csum_data(kaddr, csum, PAGE_SIZE);
76                 btrfs_csum_final(csum, (u8 *)&csum);
77                 kunmap_atomic(kaddr);
78
79                 if (csum != *cb_sum) {
80                         btrfs_print_data_csum_error(inode, disk_start, csum,
81                                         *cb_sum, cb->mirror_num);
82                         ret = -EIO;
83                         goto fail;
84                 }
85                 cb_sum++;
86
87         }
88         ret = 0;
89 fail:
90         return ret;
91 }
92
93 /* when we finish reading compressed pages from the disk, we
94  * decompress them and then run the bio end_io routines on the
95  * decompressed pages (in the inode address space).
96  *
97  * This allows the checksumming and other IO error handling routines
98  * to work normally
99  *
100  * The compressed pages are freed here, and it must be run
101  * in process context
102  */
103 static void end_compressed_bio_read(struct bio *bio)
104 {
105         struct compressed_bio *cb = bio->bi_private;
106         struct inode *inode;
107         struct page *page;
108         unsigned long index;
109         unsigned int mirror = btrfs_io_bio(bio)->mirror_num;
110         int ret = 0;
111
112         if (bio->bi_status)
113                 cb->errors = 1;
114
115         /* if there are more bios still pending for this compressed
116          * extent, just exit
117          */
118         if (!refcount_dec_and_test(&cb->pending_bios))
119                 goto out;
120
121         /*
122          * Record the correct mirror_num in cb->orig_bio so that
123          * read-repair can work properly.
124          */
125         ASSERT(btrfs_io_bio(cb->orig_bio));
126         btrfs_io_bio(cb->orig_bio)->mirror_num = mirror;
127         cb->mirror_num = mirror;
128
129         /*
130          * Some IO in this cb have failed, just skip checksum as there
131          * is no way it could be correct.
132          */
133         if (cb->errors == 1)
134                 goto csum_failed;
135
136         inode = cb->inode;
137         ret = check_compressed_csum(BTRFS_I(inode), cb,
138                                     (u64)bio->bi_iter.bi_sector << 9);
139         if (ret)
140                 goto csum_failed;
141
142         /* ok, we're the last bio for this extent, lets start
143          * the decompression.
144          */
145         ret = btrfs_decompress_bio(cb);
146
147 csum_failed:
148         if (ret)
149                 cb->errors = 1;
150
151         /* release the compressed pages */
152         index = 0;
153         for (index = 0; index < cb->nr_pages; index++) {
154                 page = cb->compressed_pages[index];
155                 page->mapping = NULL;
156                 put_page(page);
157         }
158
159         /* do io completion on the original bio */
160         if (cb->errors) {
161                 bio_io_error(cb->orig_bio);
162         } else {
163                 int i;
164                 struct bio_vec *bvec;
165
166                 /*
167                  * we have verified the checksum already, set page
168                  * checked so the end_io handlers know about it
169                  */
170                 ASSERT(!bio_flagged(bio, BIO_CLONED));
171                 bio_for_each_segment_all(bvec, cb->orig_bio, i)
172                         SetPageChecked(bvec->bv_page);
173
174                 bio_endio(cb->orig_bio);
175         }
176
177         /* finally free the cb struct */
178         kfree(cb->compressed_pages);
179         kfree(cb);
180 out:
181         bio_put(bio);
182 }
183
184 /*
185  * Clear the writeback bits on all of the file
186  * pages for a compressed write
187  */
188 static noinline void end_compressed_writeback(struct inode *inode,
189                                               const struct compressed_bio *cb)
190 {
191         unsigned long index = cb->start >> PAGE_SHIFT;
192         unsigned long end_index = (cb->start + cb->len - 1) >> PAGE_SHIFT;
193         struct page *pages[16];
194         unsigned long nr_pages = end_index - index + 1;
195         int i;
196         int ret;
197
198         if (cb->errors)
199                 mapping_set_error(inode->i_mapping, -EIO);
200
201         while (nr_pages > 0) {
202                 ret = find_get_pages_contig(inode->i_mapping, index,
203                                      min_t(unsigned long,
204                                      nr_pages, ARRAY_SIZE(pages)), pages);
205                 if (ret == 0) {
206                         nr_pages -= 1;
207                         index += 1;
208                         continue;
209                 }
210                 for (i = 0; i < ret; i++) {
211                         if (cb->errors)
212                                 SetPageError(pages[i]);
213                         end_page_writeback(pages[i]);
214                         put_page(pages[i]);
215                 }
216                 nr_pages -= ret;
217                 index += ret;
218         }
219         /* the inode may be gone now */
220 }
221
222 /*
223  * do the cleanup once all the compressed pages hit the disk.
224  * This will clear writeback on the file pages and free the compressed
225  * pages.
226  *
227  * This also calls the writeback end hooks for the file pages so that
228  * metadata and checksums can be updated in the file.
229  */
230 static void end_compressed_bio_write(struct bio *bio)
231 {
232         struct extent_io_tree *tree;
233         struct compressed_bio *cb = bio->bi_private;
234         struct inode *inode;
235         struct page *page;
236         unsigned long index;
237
238         if (bio->bi_status)
239                 cb->errors = 1;
240
241         /* if there are more bios still pending for this compressed
242          * extent, just exit
243          */
244         if (!refcount_dec_and_test(&cb->pending_bios))
245                 goto out;
246
247         /* ok, we're the last bio for this extent, step one is to
248          * call back into the FS and do all the end_io operations
249          */
250         inode = cb->inode;
251         tree = &BTRFS_I(inode)->io_tree;
252         cb->compressed_pages[0]->mapping = cb->inode->i_mapping;
253         tree->ops->writepage_end_io_hook(cb->compressed_pages[0],
254                                          cb->start,
255                                          cb->start + cb->len - 1,
256                                          NULL,
257                                          bio->bi_status ?
258                                          BLK_STS_OK : BLK_STS_NOTSUPP);
259         cb->compressed_pages[0]->mapping = NULL;
260
261         end_compressed_writeback(inode, cb);
262         /* note, our inode could be gone now */
263
264         /*
265          * release the compressed pages, these came from alloc_page and
266          * are not attached to the inode at all
267          */
268         index = 0;
269         for (index = 0; index < cb->nr_pages; index++) {
270                 page = cb->compressed_pages[index];
271                 page->mapping = NULL;
272                 put_page(page);
273         }
274
275         /* finally free the cb struct */
276         kfree(cb->compressed_pages);
277         kfree(cb);
278 out:
279         bio_put(bio);
280 }
281
282 /*
283  * worker function to build and submit bios for previously compressed pages.
284  * The corresponding pages in the inode should be marked for writeback
285  * and the compressed pages should have a reference on them for dropping
286  * when the IO is complete.
287  *
288  * This also checksums the file bytes and gets things ready for
289  * the end io hooks.
290  */
291 blk_status_t btrfs_submit_compressed_write(struct inode *inode, u64 start,
292                                  unsigned long len, u64 disk_start,
293                                  unsigned long compressed_len,
294                                  struct page **compressed_pages,
295                                  unsigned long nr_pages,
296                                  unsigned int write_flags)
297 {
298         struct btrfs_fs_info *fs_info = btrfs_sb(inode->i_sb);
299         struct bio *bio = NULL;
300         struct compressed_bio *cb;
301         unsigned long bytes_left;
302         struct extent_io_tree *io_tree = &BTRFS_I(inode)->io_tree;
303         int pg_index = 0;
304         struct page *page;
305         u64 first_byte = disk_start;
306         struct block_device *bdev;
307         blk_status_t ret;
308         int skip_sum = BTRFS_I(inode)->flags & BTRFS_INODE_NODATASUM;
309
310         WARN_ON(start & ((u64)PAGE_SIZE - 1));
311         cb = kmalloc(compressed_bio_size(fs_info, compressed_len), GFP_NOFS);
312         if (!cb)
313                 return BLK_STS_RESOURCE;
314         refcount_set(&cb->pending_bios, 0);
315         cb->errors = 0;
316         cb->inode = inode;
317         cb->start = start;
318         cb->len = len;
319         cb->mirror_num = 0;
320         cb->compressed_pages = compressed_pages;
321         cb->compressed_len = compressed_len;
322         cb->orig_bio = NULL;
323         cb->nr_pages = nr_pages;
324
325         bdev = fs_info->fs_devices->latest_bdev;
326
327         bio = btrfs_bio_alloc(bdev, first_byte);
328         bio->bi_opf = REQ_OP_WRITE | write_flags;
329         bio->bi_private = cb;
330         bio->bi_end_io = end_compressed_bio_write;
331         refcount_set(&cb->pending_bios, 1);
332
333         /* create and submit bios for the compressed pages */
334         bytes_left = compressed_len;
335         for (pg_index = 0; pg_index < cb->nr_pages; pg_index++) {
336                 int submit = 0;
337
338                 page = compressed_pages[pg_index];
339                 page->mapping = inode->i_mapping;
340                 if (bio->bi_iter.bi_size)
341                         submit = io_tree->ops->merge_bio_hook(page, 0,
342                                                            PAGE_SIZE,
343                                                            bio, 0);
344
345                 page->mapping = NULL;
346                 if (submit || bio_add_page(bio, page, PAGE_SIZE, 0) <
347                     PAGE_SIZE) {
348                         /*
349                          * inc the count before we submit the bio so
350                          * we know the end IO handler won't happen before
351                          * we inc the count.  Otherwise, the cb might get
352                          * freed before we're done setting it up
353                          */
354                         refcount_inc(&cb->pending_bios);
355                         ret = btrfs_bio_wq_end_io(fs_info, bio,
356                                                   BTRFS_WQ_ENDIO_DATA);
357                         BUG_ON(ret); /* -ENOMEM */
358
359                         if (!skip_sum) {
360                                 ret = btrfs_csum_one_bio(inode, bio, start, 1);
361                                 BUG_ON(ret); /* -ENOMEM */
362                         }
363
364                         ret = btrfs_map_bio(fs_info, bio, 0, 1);
365                         if (ret) {
366                                 bio->bi_status = ret;
367                                 bio_endio(bio);
368                         }
369
370                         bio = btrfs_bio_alloc(bdev, first_byte);
371                         bio->bi_opf = REQ_OP_WRITE | write_flags;
372                         bio->bi_private = cb;
373                         bio->bi_end_io = end_compressed_bio_write;
374                         bio_add_page(bio, page, PAGE_SIZE, 0);
375                 }
376                 if (bytes_left < PAGE_SIZE) {
377                         btrfs_info(fs_info,
378                                         "bytes left %lu compress len %lu nr %lu",
379                                bytes_left, cb->compressed_len, cb->nr_pages);
380                 }
381                 bytes_left -= PAGE_SIZE;
382                 first_byte += PAGE_SIZE;
383                 cond_resched();
384         }
385
386         ret = btrfs_bio_wq_end_io(fs_info, bio, BTRFS_WQ_ENDIO_DATA);
387         BUG_ON(ret); /* -ENOMEM */
388
389         if (!skip_sum) {
390                 ret = btrfs_csum_one_bio(inode, bio, start, 1);
391                 BUG_ON(ret); /* -ENOMEM */
392         }
393
394         ret = btrfs_map_bio(fs_info, bio, 0, 1);
395         if (ret) {
396                 bio->bi_status = ret;
397                 bio_endio(bio);
398         }
399
400         return 0;
401 }
402
403 static u64 bio_end_offset(struct bio *bio)
404 {
405         struct bio_vec *last = bio_last_bvec_all(bio);
406
407         return page_offset(last->bv_page) + last->bv_len + last->bv_offset;
408 }
409
410 static noinline int add_ra_bio_pages(struct inode *inode,
411                                      u64 compressed_end,
412                                      struct compressed_bio *cb)
413 {
414         unsigned long end_index;
415         unsigned long pg_index;
416         u64 last_offset;
417         u64 isize = i_size_read(inode);
418         int ret;
419         struct page *page;
420         unsigned long nr_pages = 0;
421         struct extent_map *em;
422         struct address_space *mapping = inode->i_mapping;
423         struct extent_map_tree *em_tree;
424         struct extent_io_tree *tree;
425         u64 end;
426         int misses = 0;
427
428         last_offset = bio_end_offset(cb->orig_bio);
429         em_tree = &BTRFS_I(inode)->extent_tree;
430         tree = &BTRFS_I(inode)->io_tree;
431
432         if (isize == 0)
433                 return 0;
434
435         end_index = (i_size_read(inode) - 1) >> PAGE_SHIFT;
436
437         while (last_offset < compressed_end) {
438                 pg_index = last_offset >> PAGE_SHIFT;
439
440                 if (pg_index > end_index)
441                         break;
442
443                 rcu_read_lock();
444                 page = radix_tree_lookup(&mapping->i_pages, pg_index);
445                 rcu_read_unlock();
446                 if (page && !radix_tree_exceptional_entry(page)) {
447                         misses++;
448                         if (misses > 4)
449                                 break;
450                         goto next;
451                 }
452
453                 page = __page_cache_alloc(mapping_gfp_constraint(mapping,
454                                                                  ~__GFP_FS));
455                 if (!page)
456                         break;
457
458                 if (add_to_page_cache_lru(page, mapping, pg_index, GFP_NOFS)) {
459                         put_page(page);
460                         goto next;
461                 }
462
463                 end = last_offset + PAGE_SIZE - 1;
464                 /*
465                  * at this point, we have a locked page in the page cache
466                  * for these bytes in the file.  But, we have to make
467                  * sure they map to this compressed extent on disk.
468                  */
469                 set_page_extent_mapped(page);
470                 lock_extent(tree, last_offset, end);
471                 read_lock(&em_tree->lock);
472                 em = lookup_extent_mapping(em_tree, last_offset,
473                                            PAGE_SIZE);
474                 read_unlock(&em_tree->lock);
475
476                 if (!em || last_offset < em->start ||
477                     (last_offset + PAGE_SIZE > extent_map_end(em)) ||
478                     (em->block_start >> 9) != cb->orig_bio->bi_iter.bi_sector) {
479                         free_extent_map(em);
480                         unlock_extent(tree, last_offset, end);
481                         unlock_page(page);
482                         put_page(page);
483                         break;
484                 }
485                 free_extent_map(em);
486
487                 if (page->index == end_index) {
488                         char *userpage;
489                         size_t zero_offset = isize & (PAGE_SIZE - 1);
490
491                         if (zero_offset) {
492                                 int zeros;
493                                 zeros = PAGE_SIZE - zero_offset;
494                                 userpage = kmap_atomic(page);
495                                 memset(userpage + zero_offset, 0, zeros);
496                                 flush_dcache_page(page);
497                                 kunmap_atomic(userpage);
498                         }
499                 }
500
501                 ret = bio_add_page(cb->orig_bio, page,
502                                    PAGE_SIZE, 0);
503
504                 if (ret == PAGE_SIZE) {
505                         nr_pages++;
506                         put_page(page);
507                 } else {
508                         unlock_extent(tree, last_offset, end);
509                         unlock_page(page);
510                         put_page(page);
511                         break;
512                 }
513 next:
514                 last_offset += PAGE_SIZE;
515         }
516         return 0;
517 }
518
519 /*
520  * for a compressed read, the bio we get passed has all the inode pages
521  * in it.  We don't actually do IO on those pages but allocate new ones
522  * to hold the compressed pages on disk.
523  *
524  * bio->bi_iter.bi_sector points to the compressed extent on disk
525  * bio->bi_io_vec points to all of the inode pages
526  *
527  * After the compressed pages are read, we copy the bytes into the
528  * bio we were passed and then call the bio end_io calls
529  */
530 blk_status_t btrfs_submit_compressed_read(struct inode *inode, struct bio *bio,
531                                  int mirror_num, unsigned long bio_flags)
532 {
533         struct btrfs_fs_info *fs_info = btrfs_sb(inode->i_sb);
534         struct extent_io_tree *tree;
535         struct extent_map_tree *em_tree;
536         struct compressed_bio *cb;
537         unsigned long compressed_len;
538         unsigned long nr_pages;
539         unsigned long pg_index;
540         struct page *page;
541         struct block_device *bdev;
542         struct bio *comp_bio;
543         u64 cur_disk_byte = (u64)bio->bi_iter.bi_sector << 9;
544         u64 em_len;
545         u64 em_start;
546         struct extent_map *em;
547         blk_status_t ret = BLK_STS_RESOURCE;
548         int faili = 0;
549         u32 *sums;
550
551         tree = &BTRFS_I(inode)->io_tree;
552         em_tree = &BTRFS_I(inode)->extent_tree;
553
554         /* we need the actual starting offset of this extent in the file */
555         read_lock(&em_tree->lock);
556         em = lookup_extent_mapping(em_tree,
557                                    page_offset(bio_first_page_all(bio)),
558                                    PAGE_SIZE);
559         read_unlock(&em_tree->lock);
560         if (!em)
561                 return BLK_STS_IOERR;
562
563         compressed_len = em->block_len;
564         cb = kmalloc(compressed_bio_size(fs_info, compressed_len), GFP_NOFS);
565         if (!cb)
566                 goto out;
567
568         refcount_set(&cb->pending_bios, 0);
569         cb->errors = 0;
570         cb->inode = inode;
571         cb->mirror_num = mirror_num;
572         sums = &cb->sums;
573
574         cb->start = em->orig_start;
575         em_len = em->len;
576         em_start = em->start;
577
578         free_extent_map(em);
579         em = NULL;
580
581         cb->len = bio->bi_iter.bi_size;
582         cb->compressed_len = compressed_len;
583         cb->compress_type = extent_compress_type(bio_flags);
584         cb->orig_bio = bio;
585
586         nr_pages = DIV_ROUND_UP(compressed_len, PAGE_SIZE);
587         cb->compressed_pages = kcalloc(nr_pages, sizeof(struct page *),
588                                        GFP_NOFS);
589         if (!cb->compressed_pages)
590                 goto fail1;
591
592         bdev = fs_info->fs_devices->latest_bdev;
593
594         for (pg_index = 0; pg_index < nr_pages; pg_index++) {
595                 cb->compressed_pages[pg_index] = alloc_page(GFP_NOFS |
596                                                               __GFP_HIGHMEM);
597                 if (!cb->compressed_pages[pg_index]) {
598                         faili = pg_index - 1;
599                         ret = BLK_STS_RESOURCE;
600                         goto fail2;
601                 }
602         }
603         faili = nr_pages - 1;
604         cb->nr_pages = nr_pages;
605
606         add_ra_bio_pages(inode, em_start + em_len, cb);
607
608         /* include any pages we added in add_ra-bio_pages */
609         cb->len = bio->bi_iter.bi_size;
610
611         comp_bio = btrfs_bio_alloc(bdev, cur_disk_byte);
612         bio_set_op_attrs (comp_bio, REQ_OP_READ, 0);
613         comp_bio->bi_private = cb;
614         comp_bio->bi_end_io = end_compressed_bio_read;
615         refcount_set(&cb->pending_bios, 1);
616
617         for (pg_index = 0; pg_index < nr_pages; pg_index++) {
618                 int submit = 0;
619
620                 page = cb->compressed_pages[pg_index];
621                 page->mapping = inode->i_mapping;
622                 page->index = em_start >> PAGE_SHIFT;
623
624                 if (comp_bio->bi_iter.bi_size)
625                         submit = tree->ops->merge_bio_hook(page, 0,
626                                                         PAGE_SIZE,
627                                                         comp_bio, 0);
628
629                 page->mapping = NULL;
630                 if (submit || bio_add_page(comp_bio, page, PAGE_SIZE, 0) <
631                     PAGE_SIZE) {
632                         ret = btrfs_bio_wq_end_io(fs_info, comp_bio,
633                                                   BTRFS_WQ_ENDIO_DATA);
634                         BUG_ON(ret); /* -ENOMEM */
635
636                         /*
637                          * inc the count before we submit the bio so
638                          * we know the end IO handler won't happen before
639                          * we inc the count.  Otherwise, the cb might get
640                          * freed before we're done setting it up
641                          */
642                         refcount_inc(&cb->pending_bios);
643
644                         if (!(BTRFS_I(inode)->flags & BTRFS_INODE_NODATASUM)) {
645                                 ret = btrfs_lookup_bio_sums(inode, comp_bio,
646                                                             sums);
647                                 BUG_ON(ret); /* -ENOMEM */
648                         }
649                         sums += DIV_ROUND_UP(comp_bio->bi_iter.bi_size,
650                                              fs_info->sectorsize);
651
652                         ret = btrfs_map_bio(fs_info, comp_bio, mirror_num, 0);
653                         if (ret) {
654                                 comp_bio->bi_status = ret;
655                                 bio_endio(comp_bio);
656                         }
657
658                         comp_bio = btrfs_bio_alloc(bdev, cur_disk_byte);
659                         bio_set_op_attrs(comp_bio, REQ_OP_READ, 0);
660                         comp_bio->bi_private = cb;
661                         comp_bio->bi_end_io = end_compressed_bio_read;
662
663                         bio_add_page(comp_bio, page, PAGE_SIZE, 0);
664                 }
665                 cur_disk_byte += PAGE_SIZE;
666         }
667
668         ret = btrfs_bio_wq_end_io(fs_info, comp_bio, BTRFS_WQ_ENDIO_DATA);
669         BUG_ON(ret); /* -ENOMEM */
670
671         if (!(BTRFS_I(inode)->flags & BTRFS_INODE_NODATASUM)) {
672                 ret = btrfs_lookup_bio_sums(inode, comp_bio, sums);
673                 BUG_ON(ret); /* -ENOMEM */
674         }
675
676         ret = btrfs_map_bio(fs_info, comp_bio, mirror_num, 0);
677         if (ret) {
678                 comp_bio->bi_status = ret;
679                 bio_endio(comp_bio);
680         }
681
682         return 0;
683
684 fail2:
685         while (faili >= 0) {
686                 __free_page(cb->compressed_pages[faili]);
687                 faili--;
688         }
689
690         kfree(cb->compressed_pages);
691 fail1:
692         kfree(cb);
693 out:
694         free_extent_map(em);
695         return ret;
696 }
697
698 /*
699  * Heuristic uses systematic sampling to collect data from the input data
700  * range, the logic can be tuned by the following constants:
701  *
702  * @SAMPLING_READ_SIZE - how many bytes will be copied from for each sample
703  * @SAMPLING_INTERVAL  - range from which the sampled data can be collected
704  */
705 #define SAMPLING_READ_SIZE      (16)
706 #define SAMPLING_INTERVAL       (256)
707
708 /*
709  * For statistical analysis of the input data we consider bytes that form a
710  * Galois Field of 256 objects. Each object has an attribute count, ie. how
711  * many times the object appeared in the sample.
712  */
713 #define BUCKET_SIZE             (256)
714
715 /*
716  * The size of the sample is based on a statistical sampling rule of thumb.
717  * The common way is to perform sampling tests as long as the number of
718  * elements in each cell is at least 5.
719  *
720  * Instead of 5, we choose 32 to obtain more accurate results.
721  * If the data contain the maximum number of symbols, which is 256, we obtain a
722  * sample size bound by 8192.
723  *
724  * For a sample of at most 8KB of data per data range: 16 consecutive bytes
725  * from up to 512 locations.
726  */
727 #define MAX_SAMPLE_SIZE         (BTRFS_MAX_UNCOMPRESSED *               \
728                                  SAMPLING_READ_SIZE / SAMPLING_INTERVAL)
729
730 struct bucket_item {
731         u32 count;
732 };
733
734 struct heuristic_ws {
735         /* Partial copy of input data */
736         u8 *sample;
737         u32 sample_size;
738         /* Buckets store counters for each byte value */
739         struct bucket_item *bucket;
740         /* Sorting buffer */
741         struct bucket_item *bucket_b;
742         struct list_head list;
743 };
744
745 static void free_heuristic_ws(struct list_head *ws)
746 {
747         struct heuristic_ws *workspace;
748
749         workspace = list_entry(ws, struct heuristic_ws, list);
750
751         kvfree(workspace->sample);
752         kfree(workspace->bucket);
753         kfree(workspace->bucket_b);
754         kfree(workspace);
755 }
756
757 static struct list_head *alloc_heuristic_ws(void)
758 {
759         struct heuristic_ws *ws;
760
761         ws = kzalloc(sizeof(*ws), GFP_KERNEL);
762         if (!ws)
763                 return ERR_PTR(-ENOMEM);
764
765         ws->sample = kvmalloc(MAX_SAMPLE_SIZE, GFP_KERNEL);
766         if (!ws->sample)
767                 goto fail;
768
769         ws->bucket = kcalloc(BUCKET_SIZE, sizeof(*ws->bucket), GFP_KERNEL);
770         if (!ws->bucket)
771                 goto fail;
772
773         ws->bucket_b = kcalloc(BUCKET_SIZE, sizeof(*ws->bucket_b), GFP_KERNEL);
774         if (!ws->bucket_b)
775                 goto fail;
776
777         INIT_LIST_HEAD(&ws->list);
778         return &ws->list;
779 fail:
780         free_heuristic_ws(&ws->list);
781         return ERR_PTR(-ENOMEM);
782 }
783
784 struct workspaces_list {
785         struct list_head idle_ws;
786         spinlock_t ws_lock;
787         /* Number of free workspaces */
788         int free_ws;
789         /* Total number of allocated workspaces */
790         atomic_t total_ws;
791         /* Waiters for a free workspace */
792         wait_queue_head_t ws_wait;
793 };
794
795 static struct workspaces_list btrfs_comp_ws[BTRFS_COMPRESS_TYPES];
796
797 static struct workspaces_list btrfs_heuristic_ws;
798
799 static const struct btrfs_compress_op * const btrfs_compress_op[] = {
800         &btrfs_zlib_compress,
801         &btrfs_lzo_compress,
802         &btrfs_zstd_compress,
803 };
804
805 void __init btrfs_init_compress(void)
806 {
807         struct list_head *workspace;
808         int i;
809
810         INIT_LIST_HEAD(&btrfs_heuristic_ws.idle_ws);
811         spin_lock_init(&btrfs_heuristic_ws.ws_lock);
812         atomic_set(&btrfs_heuristic_ws.total_ws, 0);
813         init_waitqueue_head(&btrfs_heuristic_ws.ws_wait);
814
815         workspace = alloc_heuristic_ws();
816         if (IS_ERR(workspace)) {
817                 pr_warn(
818         "BTRFS: cannot preallocate heuristic workspace, will try later\n");
819         } else {
820                 atomic_set(&btrfs_heuristic_ws.total_ws, 1);
821                 btrfs_heuristic_ws.free_ws = 1;
822                 list_add(workspace, &btrfs_heuristic_ws.idle_ws);
823         }
824
825         for (i = 0; i < BTRFS_COMPRESS_TYPES; i++) {
826                 INIT_LIST_HEAD(&btrfs_comp_ws[i].idle_ws);
827                 spin_lock_init(&btrfs_comp_ws[i].ws_lock);
828                 atomic_set(&btrfs_comp_ws[i].total_ws, 0);
829                 init_waitqueue_head(&btrfs_comp_ws[i].ws_wait);
830
831                 /*
832                  * Preallocate one workspace for each compression type so
833                  * we can guarantee forward progress in the worst case
834                  */
835                 workspace = btrfs_compress_op[i]->alloc_workspace();
836                 if (IS_ERR(workspace)) {
837                         pr_warn("BTRFS: cannot preallocate compression workspace, will try later\n");
838                 } else {
839                         atomic_set(&btrfs_comp_ws[i].total_ws, 1);
840                         btrfs_comp_ws[i].free_ws = 1;
841                         list_add(workspace, &btrfs_comp_ws[i].idle_ws);
842                 }
843         }
844 }
845
846 /*
847  * This finds an available workspace or allocates a new one.
848  * If it's not possible to allocate a new one, waits until there's one.
849  * Preallocation makes a forward progress guarantees and we do not return
850  * errors.
851  */
852 static struct list_head *__find_workspace(int type, bool heuristic)
853 {
854         struct list_head *workspace;
855         int cpus = num_online_cpus();
856         int idx = type - 1;
857         unsigned nofs_flag;
858         struct list_head *idle_ws;
859         spinlock_t *ws_lock;
860         atomic_t *total_ws;
861         wait_queue_head_t *ws_wait;
862         int *free_ws;
863
864         if (heuristic) {
865                 idle_ws  = &btrfs_heuristic_ws.idle_ws;
866                 ws_lock  = &btrfs_heuristic_ws.ws_lock;
867                 total_ws = &btrfs_heuristic_ws.total_ws;
868                 ws_wait  = &btrfs_heuristic_ws.ws_wait;
869                 free_ws  = &btrfs_heuristic_ws.free_ws;
870         } else {
871                 idle_ws  = &btrfs_comp_ws[idx].idle_ws;
872                 ws_lock  = &btrfs_comp_ws[idx].ws_lock;
873                 total_ws = &btrfs_comp_ws[idx].total_ws;
874                 ws_wait  = &btrfs_comp_ws[idx].ws_wait;
875                 free_ws  = &btrfs_comp_ws[idx].free_ws;
876         }
877
878 again:
879         spin_lock(ws_lock);
880         if (!list_empty(idle_ws)) {
881                 workspace = idle_ws->next;
882                 list_del(workspace);
883                 (*free_ws)--;
884                 spin_unlock(ws_lock);
885                 return workspace;
886
887         }
888         if (atomic_read(total_ws) > cpus) {
889                 DEFINE_WAIT(wait);
890
891                 spin_unlock(ws_lock);
892                 prepare_to_wait(ws_wait, &wait, TASK_UNINTERRUPTIBLE);
893                 if (atomic_read(total_ws) > cpus && !*free_ws)
894                         schedule();
895                 finish_wait(ws_wait, &wait);
896                 goto again;
897         }
898         atomic_inc(total_ws);
899         spin_unlock(ws_lock);
900
901         /*
902          * Allocation helpers call vmalloc that can't use GFP_NOFS, so we have
903          * to turn it off here because we might get called from the restricted
904          * context of btrfs_compress_bio/btrfs_compress_pages
905          */
906         nofs_flag = memalloc_nofs_save();
907         if (heuristic)
908                 workspace = alloc_heuristic_ws();
909         else
910                 workspace = btrfs_compress_op[idx]->alloc_workspace();
911         memalloc_nofs_restore(nofs_flag);
912
913         if (IS_ERR(workspace)) {
914                 atomic_dec(total_ws);
915                 wake_up(ws_wait);
916
917                 /*
918                  * Do not return the error but go back to waiting. There's a
919                  * workspace preallocated for each type and the compression
920                  * time is bounded so we get to a workspace eventually. This
921                  * makes our caller's life easier.
922                  *
923                  * To prevent silent and low-probability deadlocks (when the
924                  * initial preallocation fails), check if there are any
925                  * workspaces at all.
926                  */
927                 if (atomic_read(total_ws) == 0) {
928                         static DEFINE_RATELIMIT_STATE(_rs,
929                                         /* once per minute */ 60 * HZ,
930                                         /* no burst */ 1);
931
932                         if (__ratelimit(&_rs)) {
933                                 pr_warn("BTRFS: no compression workspaces, low memory, retrying\n");
934                         }
935                 }
936                 goto again;
937         }
938         return workspace;
939 }
940
941 static struct list_head *find_workspace(int type)
942 {
943         return __find_workspace(type, false);
944 }
945
946 /*
947  * put a workspace struct back on the list or free it if we have enough
948  * idle ones sitting around
949  */
950 static void __free_workspace(int type, struct list_head *workspace,
951                              bool heuristic)
952 {
953         int idx = type - 1;
954         struct list_head *idle_ws;
955         spinlock_t *ws_lock;
956         atomic_t *total_ws;
957         wait_queue_head_t *ws_wait;
958         int *free_ws;
959
960         if (heuristic) {
961                 idle_ws  = &btrfs_heuristic_ws.idle_ws;
962                 ws_lock  = &btrfs_heuristic_ws.ws_lock;
963                 total_ws = &btrfs_heuristic_ws.total_ws;
964                 ws_wait  = &btrfs_heuristic_ws.ws_wait;
965                 free_ws  = &btrfs_heuristic_ws.free_ws;
966         } else {
967                 idle_ws  = &btrfs_comp_ws[idx].idle_ws;
968                 ws_lock  = &btrfs_comp_ws[idx].ws_lock;
969                 total_ws = &btrfs_comp_ws[idx].total_ws;
970                 ws_wait  = &btrfs_comp_ws[idx].ws_wait;
971                 free_ws  = &btrfs_comp_ws[idx].free_ws;
972         }
973
974         spin_lock(ws_lock);
975         if (*free_ws <= num_online_cpus()) {
976                 list_add(workspace, idle_ws);
977                 (*free_ws)++;
978                 spin_unlock(ws_lock);
979                 goto wake;
980         }
981         spin_unlock(ws_lock);
982
983         if (heuristic)
984                 free_heuristic_ws(workspace);
985         else
986                 btrfs_compress_op[idx]->free_workspace(workspace);
987         atomic_dec(total_ws);
988 wake:
989         cond_wake_up(ws_wait);
990 }
991
992 static void free_workspace(int type, struct list_head *ws)
993 {
994         return __free_workspace(type, ws, false);
995 }
996
997 /*
998  * cleanup function for module exit
999  */
1000 static void free_workspaces(void)
1001 {
1002         struct list_head *workspace;
1003         int i;
1004
1005         while (!list_empty(&btrfs_heuristic_ws.idle_ws)) {
1006                 workspace = btrfs_heuristic_ws.idle_ws.next;
1007                 list_del(workspace);
1008                 free_heuristic_ws(workspace);
1009                 atomic_dec(&btrfs_heuristic_ws.total_ws);
1010         }
1011
1012         for (i = 0; i < BTRFS_COMPRESS_TYPES; i++) {
1013                 while (!list_empty(&btrfs_comp_ws[i].idle_ws)) {
1014                         workspace = btrfs_comp_ws[i].idle_ws.next;
1015                         list_del(workspace);
1016                         btrfs_compress_op[i]->free_workspace(workspace);
1017                         atomic_dec(&btrfs_comp_ws[i].total_ws);
1018                 }
1019         }
1020 }
1021
1022 /*
1023  * Given an address space and start and length, compress the bytes into @pages
1024  * that are allocated on demand.
1025  *
1026  * @type_level is encoded algorithm and level, where level 0 means whatever
1027  * default the algorithm chooses and is opaque here;
1028  * - compression algo are 0-3
1029  * - the level are bits 4-7
1030  *
1031  * @out_pages is an in/out parameter, holds maximum number of pages to allocate
1032  * and returns number of actually allocated pages
1033  *
1034  * @total_in is used to return the number of bytes actually read.  It
1035  * may be smaller than the input length if we had to exit early because we
1036  * ran out of room in the pages array or because we cross the
1037  * max_out threshold.
1038  *
1039  * @total_out is an in/out parameter, must be set to the input length and will
1040  * be also used to return the total number of compressed bytes
1041  *
1042  * @max_out tells us the max number of bytes that we're allowed to
1043  * stuff into pages
1044  */
1045 int btrfs_compress_pages(unsigned int type_level, struct address_space *mapping,
1046                          u64 start, struct page **pages,
1047                          unsigned long *out_pages,
1048                          unsigned long *total_in,
1049                          unsigned long *total_out)
1050 {
1051         struct list_head *workspace;
1052         int ret;
1053         int type = type_level & 0xF;
1054
1055         workspace = find_workspace(type);
1056
1057         btrfs_compress_op[type - 1]->set_level(workspace, type_level);
1058         ret = btrfs_compress_op[type-1]->compress_pages(workspace, mapping,
1059                                                       start, pages,
1060                                                       out_pages,
1061                                                       total_in, total_out);
1062         free_workspace(type, workspace);
1063         return ret;
1064 }
1065
1066 /*
1067  * pages_in is an array of pages with compressed data.
1068  *
1069  * disk_start is the starting logical offset of this array in the file
1070  *
1071  * orig_bio contains the pages from the file that we want to decompress into
1072  *
1073  * srclen is the number of bytes in pages_in
1074  *
1075  * The basic idea is that we have a bio that was created by readpages.
1076  * The pages in the bio are for the uncompressed data, and they may not
1077  * be contiguous.  They all correspond to the range of bytes covered by
1078  * the compressed extent.
1079  */
1080 static int btrfs_decompress_bio(struct compressed_bio *cb)
1081 {
1082         struct list_head *workspace;
1083         int ret;
1084         int type = cb->compress_type;
1085
1086         workspace = find_workspace(type);
1087         ret = btrfs_compress_op[type - 1]->decompress_bio(workspace, cb);
1088         free_workspace(type, workspace);
1089
1090         return ret;
1091 }
1092
1093 /*
1094  * a less complex decompression routine.  Our compressed data fits in a
1095  * single page, and we want to read a single page out of it.
1096  * start_byte tells us the offset into the compressed data we're interested in
1097  */
1098 int btrfs_decompress(int type, unsigned char *data_in, struct page *dest_page,
1099                      unsigned long start_byte, size_t srclen, size_t destlen)
1100 {
1101         struct list_head *workspace;
1102         int ret;
1103
1104         workspace = find_workspace(type);
1105
1106         ret = btrfs_compress_op[type-1]->decompress(workspace, data_in,
1107                                                   dest_page, start_byte,
1108                                                   srclen, destlen);
1109
1110         free_workspace(type, workspace);
1111         return ret;
1112 }
1113
1114 void __cold btrfs_exit_compress(void)
1115 {
1116         free_workspaces();
1117 }
1118
1119 /*
1120  * Copy uncompressed data from working buffer to pages.
1121  *
1122  * buf_start is the byte offset we're of the start of our workspace buffer.
1123  *
1124  * total_out is the last byte of the buffer
1125  */
1126 int btrfs_decompress_buf2page(const char *buf, unsigned long buf_start,
1127                               unsigned long total_out, u64 disk_start,
1128                               struct bio *bio)
1129 {
1130         unsigned long buf_offset;
1131         unsigned long current_buf_start;
1132         unsigned long start_byte;
1133         unsigned long prev_start_byte;
1134         unsigned long working_bytes = total_out - buf_start;
1135         unsigned long bytes;
1136         char *kaddr;
1137         struct bio_vec bvec = bio_iter_iovec(bio, bio->bi_iter);
1138
1139         /*
1140          * start byte is the first byte of the page we're currently
1141          * copying into relative to the start of the compressed data.
1142          */
1143         start_byte = page_offset(bvec.bv_page) - disk_start;
1144
1145         /* we haven't yet hit data corresponding to this page */
1146         if (total_out <= start_byte)
1147                 return 1;
1148
1149         /*
1150          * the start of the data we care about is offset into
1151          * the middle of our working buffer
1152          */
1153         if (total_out > start_byte && buf_start < start_byte) {
1154                 buf_offset = start_byte - buf_start;
1155                 working_bytes -= buf_offset;
1156         } else {
1157                 buf_offset = 0;
1158         }
1159         current_buf_start = buf_start;
1160
1161         /* copy bytes from the working buffer into the pages */
1162         while (working_bytes > 0) {
1163                 bytes = min_t(unsigned long, bvec.bv_len,
1164                                 PAGE_SIZE - buf_offset);
1165                 bytes = min(bytes, working_bytes);
1166
1167                 kaddr = kmap_atomic(bvec.bv_page);
1168                 memcpy(kaddr + bvec.bv_offset, buf + buf_offset, bytes);
1169                 kunmap_atomic(kaddr);
1170                 flush_dcache_page(bvec.bv_page);
1171
1172                 buf_offset += bytes;
1173                 working_bytes -= bytes;
1174                 current_buf_start += bytes;
1175
1176                 /* check if we need to pick another page */
1177                 bio_advance(bio, bytes);
1178                 if (!bio->bi_iter.bi_size)
1179                         return 0;
1180                 bvec = bio_iter_iovec(bio, bio->bi_iter);
1181                 prev_start_byte = start_byte;
1182                 start_byte = page_offset(bvec.bv_page) - disk_start;
1183
1184                 /*
1185                  * We need to make sure we're only adjusting
1186                  * our offset into compression working buffer when
1187                  * we're switching pages.  Otherwise we can incorrectly
1188                  * keep copying when we were actually done.
1189                  */
1190                 if (start_byte != prev_start_byte) {
1191                         /*
1192                          * make sure our new page is covered by this
1193                          * working buffer
1194                          */
1195                         if (total_out <= start_byte)
1196                                 return 1;
1197
1198                         /*
1199                          * the next page in the biovec might not be adjacent
1200                          * to the last page, but it might still be found
1201                          * inside this working buffer. bump our offset pointer
1202                          */
1203                         if (total_out > start_byte &&
1204                             current_buf_start < start_byte) {
1205                                 buf_offset = start_byte - buf_start;
1206                                 working_bytes = total_out - start_byte;
1207                                 current_buf_start = buf_start + buf_offset;
1208                         }
1209                 }
1210         }
1211
1212         return 1;
1213 }
1214
1215 /*
1216  * Shannon Entropy calculation
1217  *
1218  * Pure byte distribution analysis fails to determine compressiability of data.
1219  * Try calculating entropy to estimate the average minimum number of bits
1220  * needed to encode the sampled data.
1221  *
1222  * For convenience, return the percentage of needed bits, instead of amount of
1223  * bits directly.
1224  *
1225  * @ENTROPY_LVL_ACEPTABLE - below that threshold, sample has low byte entropy
1226  *                          and can be compressible with high probability
1227  *
1228  * @ENTROPY_LVL_HIGH - data are not compressible with high probability
1229  *
1230  * Use of ilog2() decreases precision, we lower the LVL to 5 to compensate.
1231  */
1232 #define ENTROPY_LVL_ACEPTABLE           (65)
1233 #define ENTROPY_LVL_HIGH                (80)
1234
1235 /*
1236  * For increasead precision in shannon_entropy calculation,
1237  * let's do pow(n, M) to save more digits after comma:
1238  *
1239  * - maximum int bit length is 64
1240  * - ilog2(MAX_SAMPLE_SIZE)     -> 13
1241  * - 13 * 4 = 52 < 64           -> M = 4
1242  *
1243  * So use pow(n, 4).
1244  */
1245 static inline u32 ilog2_w(u64 n)
1246 {
1247         return ilog2(n * n * n * n);
1248 }
1249
1250 static u32 shannon_entropy(struct heuristic_ws *ws)
1251 {
1252         const u32 entropy_max = 8 * ilog2_w(2);
1253         u32 entropy_sum = 0;
1254         u32 p, p_base, sz_base;
1255         u32 i;
1256
1257         sz_base = ilog2_w(ws->sample_size);
1258         for (i = 0; i < BUCKET_SIZE && ws->bucket[i].count > 0; i++) {
1259                 p = ws->bucket[i].count;
1260                 p_base = ilog2_w(p);
1261                 entropy_sum += p * (sz_base - p_base);
1262         }
1263
1264         entropy_sum /= ws->sample_size;
1265         return entropy_sum * 100 / entropy_max;
1266 }
1267
1268 #define RADIX_BASE              4U
1269 #define COUNTERS_SIZE           (1U << RADIX_BASE)
1270
1271 static u8 get4bits(u64 num, int shift) {
1272         u8 low4bits;
1273
1274         num >>= shift;
1275         /* Reverse order */
1276         low4bits = (COUNTERS_SIZE - 1) - (num % COUNTERS_SIZE);
1277         return low4bits;
1278 }
1279
1280 /*
1281  * Use 4 bits as radix base
1282  * Use 16 u32 counters for calculating new possition in buf array
1283  *
1284  * @array     - array that will be sorted
1285  * @array_buf - buffer array to store sorting results
1286  *              must be equal in size to @array
1287  * @num       - array size
1288  */
1289 static void radix_sort(struct bucket_item *array, struct bucket_item *array_buf,
1290                        int num)
1291 {
1292         u64 max_num;
1293         u64 buf_num;
1294         u32 counters[COUNTERS_SIZE];
1295         u32 new_addr;
1296         u32 addr;
1297         int bitlen;
1298         int shift;
1299         int i;
1300
1301         /*
1302          * Try avoid useless loop iterations for small numbers stored in big
1303          * counters.  Example: 48 33 4 ... in 64bit array
1304          */
1305         max_num = array[0].count;
1306         for (i = 1; i < num; i++) {
1307                 buf_num = array[i].count;
1308                 if (buf_num > max_num)
1309                         max_num = buf_num;
1310         }
1311
1312         buf_num = ilog2(max_num);
1313         bitlen = ALIGN(buf_num, RADIX_BASE * 2);
1314
1315         shift = 0;
1316         while (shift < bitlen) {
1317                 memset(counters, 0, sizeof(counters));
1318
1319                 for (i = 0; i < num; i++) {
1320                         buf_num = array[i].count;
1321                         addr = get4bits(buf_num, shift);
1322                         counters[addr]++;
1323                 }
1324
1325                 for (i = 1; i < COUNTERS_SIZE; i++)
1326                         counters[i] += counters[i - 1];
1327
1328                 for (i = num - 1; i >= 0; i--) {
1329                         buf_num = array[i].count;
1330                         addr = get4bits(buf_num, shift);
1331                         counters[addr]--;
1332                         new_addr = counters[addr];
1333                         array_buf[new_addr] = array[i];
1334                 }
1335
1336                 shift += RADIX_BASE;
1337
1338                 /*
1339                  * Normal radix expects to move data from a temporary array, to
1340                  * the main one.  But that requires some CPU time. Avoid that
1341                  * by doing another sort iteration to original array instead of
1342                  * memcpy()
1343                  */
1344                 memset(counters, 0, sizeof(counters));
1345
1346                 for (i = 0; i < num; i ++) {
1347                         buf_num = array_buf[i].count;
1348                         addr = get4bits(buf_num, shift);
1349                         counters[addr]++;
1350                 }
1351
1352                 for (i = 1; i < COUNTERS_SIZE; i++)
1353                         counters[i] += counters[i - 1];
1354
1355                 for (i = num - 1; i >= 0; i--) {
1356                         buf_num = array_buf[i].count;
1357                         addr = get4bits(buf_num, shift);
1358                         counters[addr]--;
1359                         new_addr = counters[addr];
1360                         array[new_addr] = array_buf[i];
1361                 }
1362
1363                 shift += RADIX_BASE;
1364         }
1365 }
1366
1367 /*
1368  * Size of the core byte set - how many bytes cover 90% of the sample
1369  *
1370  * There are several types of structured binary data that use nearly all byte
1371  * values. The distribution can be uniform and counts in all buckets will be
1372  * nearly the same (eg. encrypted data). Unlikely to be compressible.
1373  *
1374  * Other possibility is normal (Gaussian) distribution, where the data could
1375  * be potentially compressible, but we have to take a few more steps to decide
1376  * how much.
1377  *
1378  * @BYTE_CORE_SET_LOW  - main part of byte values repeated frequently,
1379  *                       compression algo can easy fix that
1380  * @BYTE_CORE_SET_HIGH - data have uniform distribution and with high
1381  *                       probability is not compressible
1382  */
1383 #define BYTE_CORE_SET_LOW               (64)
1384 #define BYTE_CORE_SET_HIGH              (200)
1385
1386 static int byte_core_set_size(struct heuristic_ws *ws)
1387 {
1388         u32 i;
1389         u32 coreset_sum = 0;
1390         const u32 core_set_threshold = ws->sample_size * 90 / 100;
1391         struct bucket_item *bucket = ws->bucket;
1392
1393         /* Sort in reverse order */
1394         radix_sort(ws->bucket, ws->bucket_b, BUCKET_SIZE);
1395
1396         for (i = 0; i < BYTE_CORE_SET_LOW; i++)
1397                 coreset_sum += bucket[i].count;
1398
1399         if (coreset_sum > core_set_threshold)
1400                 return i;
1401
1402         for (; i < BYTE_CORE_SET_HIGH && bucket[i].count > 0; i++) {
1403                 coreset_sum += bucket[i].count;
1404                 if (coreset_sum > core_set_threshold)
1405                         break;
1406         }
1407
1408         return i;
1409 }
1410
1411 /*
1412  * Count byte values in buckets.
1413  * This heuristic can detect textual data (configs, xml, json, html, etc).
1414  * Because in most text-like data byte set is restricted to limited number of
1415  * possible characters, and that restriction in most cases makes data easy to
1416  * compress.
1417  *
1418  * @BYTE_SET_THRESHOLD - consider all data within this byte set size:
1419  *      less - compressible
1420  *      more - need additional analysis
1421  */
1422 #define BYTE_SET_THRESHOLD              (64)
1423
1424 static u32 byte_set_size(const struct heuristic_ws *ws)
1425 {
1426         u32 i;
1427         u32 byte_set_size = 0;
1428
1429         for (i = 0; i < BYTE_SET_THRESHOLD; i++) {
1430                 if (ws->bucket[i].count > 0)
1431                         byte_set_size++;
1432         }
1433
1434         /*
1435          * Continue collecting count of byte values in buckets.  If the byte
1436          * set size is bigger then the threshold, it's pointless to continue,
1437          * the detection technique would fail for this type of data.
1438          */
1439         for (; i < BUCKET_SIZE; i++) {
1440                 if (ws->bucket[i].count > 0) {
1441                         byte_set_size++;
1442                         if (byte_set_size > BYTE_SET_THRESHOLD)
1443                                 return byte_set_size;
1444                 }
1445         }
1446
1447         return byte_set_size;
1448 }
1449
1450 static bool sample_repeated_patterns(struct heuristic_ws *ws)
1451 {
1452         const u32 half_of_sample = ws->sample_size / 2;
1453         const u8 *data = ws->sample;
1454
1455         return memcmp(&data[0], &data[half_of_sample], half_of_sample) == 0;
1456 }
1457
1458 static void heuristic_collect_sample(struct inode *inode, u64 start, u64 end,
1459                                      struct heuristic_ws *ws)
1460 {
1461         struct page *page;
1462         u64 index, index_end;
1463         u32 i, curr_sample_pos;
1464         u8 *in_data;
1465
1466         /*
1467          * Compression handles the input data by chunks of 128KiB
1468          * (defined by BTRFS_MAX_UNCOMPRESSED)
1469          *
1470          * We do the same for the heuristic and loop over the whole range.
1471          *
1472          * MAX_SAMPLE_SIZE - calculated under assumption that heuristic will
1473          * process no more than BTRFS_MAX_UNCOMPRESSED at a time.
1474          */
1475         if (end - start > BTRFS_MAX_UNCOMPRESSED)
1476                 end = start + BTRFS_MAX_UNCOMPRESSED;
1477
1478         index = start >> PAGE_SHIFT;
1479         index_end = end >> PAGE_SHIFT;
1480
1481         /* Don't miss unaligned end */
1482         if (!IS_ALIGNED(end, PAGE_SIZE))
1483                 index_end++;
1484
1485         curr_sample_pos = 0;
1486         while (index < index_end) {
1487                 page = find_get_page(inode->i_mapping, index);
1488                 in_data = kmap(page);
1489                 /* Handle case where the start is not aligned to PAGE_SIZE */
1490                 i = start % PAGE_SIZE;
1491                 while (i < PAGE_SIZE - SAMPLING_READ_SIZE) {
1492                         /* Don't sample any garbage from the last page */
1493                         if (start > end - SAMPLING_READ_SIZE)
1494                                 break;
1495                         memcpy(&ws->sample[curr_sample_pos], &in_data[i],
1496                                         SAMPLING_READ_SIZE);
1497                         i += SAMPLING_INTERVAL;
1498                         start += SAMPLING_INTERVAL;
1499                         curr_sample_pos += SAMPLING_READ_SIZE;
1500                 }
1501                 kunmap(page);
1502                 put_page(page);
1503
1504                 index++;
1505         }
1506
1507         ws->sample_size = curr_sample_pos;
1508 }
1509
1510 /*
1511  * Compression heuristic.
1512  *
1513  * For now is's a naive and optimistic 'return true', we'll extend the logic to
1514  * quickly (compared to direct compression) detect data characteristics
1515  * (compressible/uncompressible) to avoid wasting CPU time on uncompressible
1516  * data.
1517  *
1518  * The following types of analysis can be performed:
1519  * - detect mostly zero data
1520  * - detect data with low "byte set" size (text, etc)
1521  * - detect data with low/high "core byte" set
1522  *
1523  * Return non-zero if the compression should be done, 0 otherwise.
1524  */
1525 int btrfs_compress_heuristic(struct inode *inode, u64 start, u64 end)
1526 {
1527         struct list_head *ws_list = __find_workspace(0, true);
1528         struct heuristic_ws *ws;
1529         u32 i;
1530         u8 byte;
1531         int ret = 0;
1532
1533         ws = list_entry(ws_list, struct heuristic_ws, list);
1534
1535         heuristic_collect_sample(inode, start, end, ws);
1536
1537         if (sample_repeated_patterns(ws)) {
1538                 ret = 1;
1539                 goto out;
1540         }
1541
1542         memset(ws->bucket, 0, sizeof(*ws->bucket)*BUCKET_SIZE);
1543
1544         for (i = 0; i < ws->sample_size; i++) {
1545                 byte = ws->sample[i];
1546                 ws->bucket[byte].count++;
1547         }
1548
1549         i = byte_set_size(ws);
1550         if (i < BYTE_SET_THRESHOLD) {
1551                 ret = 2;
1552                 goto out;
1553         }
1554
1555         i = byte_core_set_size(ws);
1556         if (i <= BYTE_CORE_SET_LOW) {
1557                 ret = 3;
1558                 goto out;
1559         }
1560
1561         if (i >= BYTE_CORE_SET_HIGH) {
1562                 ret = 0;
1563                 goto out;
1564         }
1565
1566         i = shannon_entropy(ws);
1567         if (i <= ENTROPY_LVL_ACEPTABLE) {
1568                 ret = 4;
1569                 goto out;
1570         }
1571
1572         /*
1573          * For the levels below ENTROPY_LVL_HIGH, additional analysis would be
1574          * needed to give green light to compression.
1575          *
1576          * For now just assume that compression at that level is not worth the
1577          * resources because:
1578          *
1579          * 1. it is possible to defrag the data later
1580          *
1581          * 2. the data would turn out to be hardly compressible, eg. 150 byte
1582          * values, every bucket has counter at level ~54. The heuristic would
1583          * be confused. This can happen when data have some internal repeated
1584          * patterns like "abbacbbc...". This can be detected by analyzing
1585          * pairs of bytes, which is too costly.
1586          */
1587         if (i < ENTROPY_LVL_HIGH) {
1588                 ret = 5;
1589                 goto out;
1590         } else {
1591                 ret = 0;
1592                 goto out;
1593         }
1594
1595 out:
1596         __free_workspace(0, ws_list, true);
1597         return ret;
1598 }
1599
1600 unsigned int btrfs_compress_str2level(const char *str)
1601 {
1602         if (strncmp(str, "zlib", 4) != 0)
1603                 return 0;
1604
1605         /* Accepted form: zlib:1 up to zlib:9 and nothing left after the number */
1606         if (str[4] == ':' && '1' <= str[5] && str[5] <= '9' && str[6] == 0)
1607                 return str[5] - '0';
1608
1609         return BTRFS_ZLIB_DEFAULT_LEVEL;
1610 }