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