fs/btrfs/compression.c

   1 /*
   2  * Copyright (C) 2008 Oracle.  All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public
   6  * License v2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public
  14  * License along with this program; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 021110-1307, USA.
  17  */
  18
  19 #include <linux/kernel.h>
  20 #include <linux/bio.h>
  21 #include <linux/buffer_head.h>
  22 #include <linux/file.h>
  23 #include <linux/fs.h>
  24 #include <linux/pagemap.h>
  25 #include <linux/highmem.h>
  26 #include <linux/time.h>
  27 #include <linux/init.h>
  28 #include <linux/string.h>
  29 #include <linux/backing-dev.h>
  30 #include <linux/mpage.h>
  31 #include <linux/swap.h>
  32 #include <linux/writeback.h>
  33 #include <linux/bit_spinlock.h>
  34 #include <linux/slab.h>
  35 #include <linux/sched/mm.h>
  36 #include "ctree.h"
  37 #include "disk-io.h"
  38 #include "transaction.h"
  39 #include "btrfs_inode.h"
  40 #include "volumes.h"
  41 #include "ordered-data.h"
  42 #include "compression.h"
  43 #include "extent_io.h"
  44 #include "extent_map.h"
  45
  46 static int btrfs_decompress_bio(struct compressed_bio *cb);
  47
  48 static inline int compressed_bio_size(struct btrfs_fs_info *fs_info,
  49                                       unsigned long disk_size)
  50 {
  51         u16 csum_size = btrfs_super_csum_size(fs_info->super_copy);
  52
  53         return sizeof(struct compressed_bio) +
  54                 (DIV_ROUND_UP(disk_size, fs_info->sectorsize)) * csum_size;
  55 }
  56
  57 static int check_compressed_csum(struct btrfs_inode *inode,
  58                                  struct compressed_bio *cb,
  59                                  u64 disk_start)
  60 {
  61         int ret;
  62         struct page *page;
  63         unsigned long i;
  64         char *kaddr;
  65         u32 csum;
  66         u32 *cb_sum = &cb->sums;
  67
  68         if (inode->flags & BTRFS_INODE_NODATASUM)
  69                 return 0;
  70
  71         for (i = 0; i < cb->nr_pages; i++) {
  72                 page = cb->compressed_pages[i];
  73                 csum = ~(u32)0;
  74
  75                 kaddr = kmap_atomic(page);
  76                 csum = btrfs_csum_data(kaddr, csum, PAGE_SIZE);
  77                 btrfs_csum_final(csum, (u8 *)&csum);
  78                 kunmap_atomic(kaddr);
  79
  80                 if (csum != *cb_sum) {
  81                         btrfs_print_data_csum_error(inode, disk_start, csum,
  82                                         *cb_sum, cb->mirror_num);
  83                         ret = -EIO;
  84                         goto fail;
  85                 }
  86                 cb_sum++;
  87
  88         }
  89         ret = 0;
  90 fail:
  91         return ret;
  92 }
  93
  94 /* when we finish reading compressed pages from the disk, we
  95  * decompress them and then run the bio end_io routines on the
  96  * decompressed pages (in the inode address space).
  97  *
  98  * This allows the checksumming and other IO error handling routines
  99  * to work normally
 100  *
 101  * The compressed pages are freed here, and it must be run
 102  * in process context
 103  */
 104 static void end_compressed_bio_read(struct bio *bio)
 105 {
 106         struct compressed_bio *cb = bio->bi_private;
 107         struct inode *inode;
 108         struct page *page;
 109         unsigned long index;
 110         unsigned int mirror = btrfs_io_bio(bio)->mirror_num;
 111         int ret = 0;
 112
 113         if (bio->bi_status)
 114                 cb->errors = 1;
 115
 116         /* if there are more bios still pending for this compressed
 117          * extent, just exit
 118          */
 119         if (!refcount_dec_and_test(&cb->pending_bios))
 120                 goto out;
 121
 122         /*
 123          * Record the correct mirror_num in cb->orig_bio so that
 124          * read-repair can work properly.
 125          */
 126         ASSERT(btrfs_io_bio(cb->orig_bio));
 127         btrfs_io_bio(cb->orig_bio)->mirror_num = mirror;
 128         cb->mirror_num = mirror;
 129
 130         /*
 131          * Some IO in this cb have failed, just skip checksum as there
 132          * is no way it could be correct.
 133          */
 134         if (cb->errors == 1)
 135                 goto csum_failed;
 136
 137         inode = cb->inode;
 138         ret = check_compressed_csum(BTRFS_I(inode), cb,
 139                                     (u64)bio->bi_iter.bi_sector << 9);
 140         if (ret)
 141                 goto csum_failed;
 142
 143         /* ok, we're the last bio for this extent, lets start
 144          * the decompression.
 145          */
 146         ret = btrfs_decompress_bio(cb);
 147
 148 csum_failed:
 149         if (ret)
 150                 cb->errors = 1;
 151
 152         /* release the compressed pages */
 153         index = 0;
 154         for (index = 0; index < cb->nr_pages; index++) {
 155                 page = cb->compressed_pages[index];
 156                 page->mapping = NULL;
 157                 put_page(page);
 158         }
 159
 160         /* do io completion on the original bio */
 161         if (cb->errors) {
 162                 bio_io_error(cb->orig_bio);
 163         } else {
 164                 int i;
 165                 struct bio_vec *bvec;
 166
 167                 /*
 168                  * we have verified the checksum already, set page
 169                  * checked so the end_io handlers know about it
 170                  */
 171                 ASSERT(!bio_flagged(bio, BIO_CLONED));
 172                 bio_for_each_segment_all(bvec, cb->orig_bio, i)
 173                         SetPageChecked(bvec->bv_page);
 174
 175                 bio_endio(cb->orig_bio);
 176         }
 177
 178         /* finally free the cb struct */
 179         kfree(cb->compressed_pages);
 180         kfree(cb);
 181 out:
 182         bio_put(bio);
 183 }
 184
 185 /*
 186  * Clear the writeback bits on all of the file
 187  * pages for a compressed write
 188  */
 189 static noinline void end_compressed_writeback(struct inode *inode,
 190                                               const struct compressed_bio *cb)
 191 {
 192         unsigned long index = cb->start >> PAGE_SHIFT;
 193         unsigned long end_index = (cb->start + cb->len - 1) >> PAGE_SHIFT;
 194         struct page *pages[16];
 195         unsigned long nr_pages = end_index - index + 1;
 196         int i;
 197         int ret;
 198
 199         if (cb->errors)
 200                 mapping_set_error(inode->i_mapping, -EIO);
 201
 202         while (nr_pages > 0) {
 203                 ret = find_get_pages_contig(inode->i_mapping, index,
 204                                      min_t(unsigned long,
 205                                      nr_pages, ARRAY_SIZE(pages)), pages);
 206                 if (ret == 0) {
 207                         nr_pages -= 1;
 208                         index += 1;
 209                         continue;
 210                 }
 211                 for (i = 0; i < ret; i++) {
 212                         if (cb->errors)
 213                                 SetPageError(pages[i]);
 214                         end_page_writeback(pages[i]);
 215                         put_page(pages[i]);
 216                 }
 217                 nr_pages -= ret;
 218                 index += ret;
 219         }
 220         /* the inode may be gone now */
 221 }
 222
 223 /*
 224  * do the cleanup once all the compressed pages hit the disk.
 225  * This will clear writeback on the file pages and free the compressed
 226  * pages.
 227  *
 228  * This also calls the writeback end hooks for the file pages so that
 229  * metadata and checksums can be updated in the file.
 230  */
 231 static void end_compressed_bio_write(struct bio *bio)
 232 {
 233         struct extent_io_tree *tree;
 234         struct compressed_bio *cb = bio->bi_private;
 235         struct inode *inode;
 236         struct page *page;
 237         unsigned long index;
 238
 239         if (bio->bi_status)
 240                 cb->errors = 1;
 241
 242         /* if there are more bios still pending for this compressed
 243          * extent, just exit
 244          */
 245         if (!refcount_dec_and_test(&cb->pending_bios))
 246                 goto out;
 247
 248         /* ok, we're the last bio for this extent, step one is to
 249          * call back into the FS and do all the end_io operations
 250          */
 251         inode = cb->inode;
 252         tree = &BTRFS_I(inode)->io_tree;
 253         cb->compressed_pages[0]->mapping = cb->inode->i_mapping;
 254         tree->ops->writepage_end_io_hook(cb->compressed_pages[0],
 255                                          cb->start,
 256                                          cb->start + cb->len - 1,
 257                                          NULL,
 258                                          bio->bi_status ?
 259                                          BLK_STS_OK : BLK_STS_NOTSUPP);
 260         cb->compressed_pages[0]->mapping = NULL;
 261
 262         end_compressed_writeback(inode, cb);
 263         /* note, our inode could be gone now */
 264
 265         /*
 266          * release the compressed pages, these came from alloc_page and
 267          * are not attached to the inode at all
 268          */
 269         index = 0;
 270         for (index = 0; index < cb->nr_pages; index++) {
 271                 page = cb->compressed_pages[index];
 272                 page->mapping = NULL;
 273                 put_page(page);
 274         }
 275
 276         /* finally free the cb struct */
 277         kfree(cb->compressed_pages);
 278         kfree(cb);
 279 out:
 280         bio_put(bio);
 281 }
 282
 283 /*
 284  * worker function to build and submit bios for previously compressed pages.
 285  * The corresponding pages in the inode should be marked for writeback
 286  * and the compressed pages should have a reference on them for dropping
 287  * when the IO is complete.
 288  *
 289  * This also checksums the file bytes and gets things ready for
 290  * the end io hooks.
 291  */
 292 blk_status_t btrfs_submit_compressed_write(struct inode *inode, u64 start,
 293                                  unsigned long len, u64 disk_start,
 294                                  unsigned long compressed_len,
 295                                  struct page **compressed_pages,
 296                                  unsigned long nr_pages)
 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_set_op_attrs(bio, REQ_OP_WRITE, 0);
 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                         bio_get(bio);
 349
 350                         /*
 351                          * inc the count before we submit the bio so
 352                          * we know the end IO handler won't happen before
 353                          * we inc the count.  Otherwise, the cb might get
 354                          * freed before we're done setting it up
 355                          */
 356                         refcount_inc(&cb->pending_bios);
 357                         ret = btrfs_bio_wq_end_io(fs_info, bio,
 358                                                   BTRFS_WQ_ENDIO_DATA);
 359                         BUG_ON(ret); /* -ENOMEM */
 360
 361                         if (!skip_sum) {
 362                                 ret = btrfs_csum_one_bio(inode, bio, start, 1);
 363                                 BUG_ON(ret); /* -ENOMEM */
 364                         }
 365
 366                         ret = btrfs_map_bio(fs_info, bio, 0, 1);
 367                         if (ret) {
 368                                 bio->bi_status = ret;
 369                                 bio_endio(bio);
 370                         }
 371
 372                         bio_put(bio);
 373
 374                         bio = btrfs_bio_alloc(bdev, first_byte);
 375                         bio_set_op_attrs(bio, REQ_OP_WRITE, 0);
 376                         bio->bi_private = cb;
 377                         bio->bi_end_io = end_compressed_bio_write;
 378                         bio_add_page(bio, page, PAGE_SIZE, 0);
 379                 }
 380                 if (bytes_left < PAGE_SIZE) {
 381                         btrfs_info(fs_info,
 382                                         "bytes left %lu compress len %lu nr %lu",
 383                                bytes_left, cb->compressed_len, cb->nr_pages);
 384                 }
 385                 bytes_left -= PAGE_SIZE;
 386                 first_byte += PAGE_SIZE;
 387                 cond_resched();
 388         }
 389         bio_get(bio);
 390
 391         ret = btrfs_bio_wq_end_io(fs_info, bio, BTRFS_WQ_ENDIO_DATA);
 392         BUG_ON(ret); /* -ENOMEM */
 393
 394         if (!skip_sum) {
 395                 ret = btrfs_csum_one_bio(inode, bio, start, 1);
 396                 BUG_ON(ret); /* -ENOMEM */
 397         }
 398
 399         ret = btrfs_map_bio(fs_info, bio, 0, 1);
 400         if (ret) {
 401                 bio->bi_status = ret;
 402                 bio_endio(bio);
 403         }
 404
 405         bio_put(bio);
 406         return 0;
 407 }
 408
 409 static u64 bio_end_offset(struct bio *bio)
 410 {
 411         struct bio_vec *last = &bio->bi_io_vec[bio->bi_vcnt - 1];
 412
 413         return page_offset(last->bv_page) + last->bv_len + last->bv_offset;
 414 }
 415
 416 static noinline int add_ra_bio_pages(struct inode *inode,
 417                                      u64 compressed_end,
 418                                      struct compressed_bio *cb)
 419 {
 420         unsigned long end_index;
 421         unsigned long pg_index;
 422         u64 last_offset;
 423         u64 isize = i_size_read(inode);
 424         int ret;
 425         struct page *page;
 426         unsigned long nr_pages = 0;
 427         struct extent_map *em;
 428         struct address_space *mapping = inode->i_mapping;
 429         struct extent_map_tree *em_tree;
 430         struct extent_io_tree *tree;
 431         u64 end;
 432         int misses = 0;
 433
 434         last_offset = bio_end_offset(cb->orig_bio);
 435         em_tree = &BTRFS_I(inode)->extent_tree;
 436         tree = &BTRFS_I(inode)->io_tree;
 437
 438         if (isize == 0)
 439                 return 0;
 440
 441         end_index = (i_size_read(inode) - 1) >> PAGE_SHIFT;
 442
 443         while (last_offset < compressed_end) {
 444                 pg_index = last_offset >> PAGE_SHIFT;
 445
 446                 if (pg_index > end_index)
 447                         break;
 448
 449                 rcu_read_lock();
 450                 page = radix_tree_lookup(&mapping->page_tree, pg_index);
 451                 rcu_read_unlock();
 452                 if (page && !radix_tree_exceptional_entry(page)) {
 453                         misses++;
 454                         if (misses > 4)
 455                                 break;
 456                         goto next;
 457                 }
 458
 459                 page = __page_cache_alloc(mapping_gfp_constraint(mapping,
 460                                                                  ~__GFP_FS));
 461                 if (!page)
 462                         break;
 463
 464                 if (add_to_page_cache_lru(page, mapping, pg_index, GFP_NOFS)) {
 465                         put_page(page);
 466                         goto next;
 467                 }
 468
 469                 end = last_offset + PAGE_SIZE - 1;
 470                 /*
 471                  * at this point, we have a locked page in the page cache
 472                  * for these bytes in the file.  But, we have to make
 473                  * sure they map to this compressed extent on disk.
 474                  */
 475                 set_page_extent_mapped(page);
 476                 lock_extent(tree, last_offset, end);
 477                 read_lock(&em_tree->lock);
 478                 em = lookup_extent_mapping(em_tree, last_offset,
 479                                            PAGE_SIZE);
 480                 read_unlock(&em_tree->lock);
 481
 482                 if (!em || last_offset < em->start ||
 483                     (last_offset + PAGE_SIZE > extent_map_end(em)) ||
 484                     (em->block_start >> 9) != cb->orig_bio->bi_iter.bi_sector) {
 485                         free_extent_map(em);
 486                         unlock_extent(tree, last_offset, end);
 487                         unlock_page(page);
 488                         put_page(page);
 489                         break;
 490                 }
 491                 free_extent_map(em);
 492
 493                 if (page->index == end_index) {
 494                         char *userpage;
 495                         size_t zero_offset = isize & (PAGE_SIZE - 1);
 496
 497                         if (zero_offset) {
 498                                 int zeros;
 499                                 zeros = PAGE_SIZE - zero_offset;
 500                                 userpage = kmap_atomic(page);
 501                                 memset(userpage + zero_offset, 0, zeros);
 502                                 flush_dcache_page(page);
 503                                 kunmap_atomic(userpage);
 504                         }
 505                 }
 506
 507                 ret = bio_add_page(cb->orig_bio, page,
 508                                    PAGE_SIZE, 0);
 509
 510                 if (ret == PAGE_SIZE) {
 511                         nr_pages++;
 512                         put_page(page);
 513                 } else {
 514                         unlock_extent(tree, last_offset, end);
 515                         unlock_page(page);
 516                         put_page(page);
 517                         break;
 518                 }
 519 next:
 520                 last_offset += PAGE_SIZE;
 521         }
 522         return 0;
 523 }
 524
 525 /*
 526  * for a compressed read, the bio we get passed has all the inode pages
 527  * in it.  We don't actually do IO on those pages but allocate new ones
 528  * to hold the compressed pages on disk.
 529  *
 530  * bio->bi_iter.bi_sector points to the compressed extent on disk
 531  * bio->bi_io_vec points to all of the inode pages
 532  *
 533  * After the compressed pages are read, we copy the bytes into the
 534  * bio we were passed and then call the bio end_io calls
 535  */
 536 blk_status_t btrfs_submit_compressed_read(struct inode *inode, struct bio *bio,
 537                                  int mirror_num, unsigned long bio_flags)
 538 {
 539         struct btrfs_fs_info *fs_info = btrfs_sb(inode->i_sb);
 540         struct extent_io_tree *tree;
 541         struct extent_map_tree *em_tree;
 542         struct compressed_bio *cb;
 543         unsigned long compressed_len;
 544         unsigned long nr_pages;
 545         unsigned long pg_index;
 546         struct page *page;
 547         struct block_device *bdev;
 548         struct bio *comp_bio;
 549         u64 cur_disk_byte = (u64)bio->bi_iter.bi_sector << 9;
 550         u64 em_len;
 551         u64 em_start;
 552         struct extent_map *em;
 553         blk_status_t ret = BLK_STS_RESOURCE;
 554         int faili = 0;
 555         u32 *sums;
 556
 557         tree = &BTRFS_I(inode)->io_tree;
 558         em_tree = &BTRFS_I(inode)->extent_tree;
 559
 560         /* we need the actual starting offset of this extent in the file */
 561         read_lock(&em_tree->lock);
 562         em = lookup_extent_mapping(em_tree,
 563                                    page_offset(bio->bi_io_vec->bv_page),
 564                                    PAGE_SIZE);
 565         read_unlock(&em_tree->lock);
 566         if (!em)
 567                 return BLK_STS_IOERR;
 568
 569         compressed_len = em->block_len;
 570         cb = kmalloc(compressed_bio_size(fs_info, compressed_len), GFP_NOFS);
 571         if (!cb)
 572                 goto out;
 573
 574         refcount_set(&cb->pending_bios, 0);
 575         cb->errors = 0;
 576         cb->inode = inode;
 577         cb->mirror_num = mirror_num;
 578         sums = &cb->sums;
 579
 580         cb->start = em->orig_start;
 581         em_len = em->len;
 582         em_start = em->start;
 583
 584         free_extent_map(em);
 585         em = NULL;
 586
 587         cb->len = bio->bi_iter.bi_size;
 588         cb->compressed_len = compressed_len;
 589         cb->compress_type = extent_compress_type(bio_flags);
 590         cb->orig_bio = bio;
 591
 592         nr_pages = DIV_ROUND_UP(compressed_len, PAGE_SIZE);
 593         cb->compressed_pages = kcalloc(nr_pages, sizeof(struct page *),
 594                                        GFP_NOFS);
 595         if (!cb->compressed_pages)
 596                 goto fail1;
 597
 598         bdev = fs_info->fs_devices->latest_bdev;
 599
 600         for (pg_index = 0; pg_index < nr_pages; pg_index++) {
 601                 cb->compressed_pages[pg_index] = alloc_page(GFP_NOFS |
 602                                                               __GFP_HIGHMEM);
 603                 if (!cb->compressed_pages[pg_index]) {
 604                         faili = pg_index - 1;
 605                         ret = BLK_STS_RESOURCE;
 606                         goto fail2;
 607                 }
 608         }
 609         faili = nr_pages - 1;
 610         cb->nr_pages = nr_pages;
 611
 612         add_ra_bio_pages(inode, em_start + em_len, cb);
 613
 614         /* include any pages we added in add_ra-bio_pages */
 615         cb->len = bio->bi_iter.bi_size;
 616
 617         comp_bio = btrfs_bio_alloc(bdev, cur_disk_byte);
 618         bio_set_op_attrs (comp_bio, REQ_OP_READ, 0);
 619         comp_bio->bi_private = cb;
 620         comp_bio->bi_end_io = end_compressed_bio_read;
 621         refcount_set(&cb->pending_bios, 1);
 622
 623         for (pg_index = 0; pg_index < nr_pages; pg_index++) {
 624                 int submit = 0;
 625
 626                 page = cb->compressed_pages[pg_index];
 627                 page->mapping = inode->i_mapping;
 628                 page->index = em_start >> PAGE_SHIFT;
 629
 630                 if (comp_bio->bi_iter.bi_size)
 631                         submit = tree->ops->merge_bio_hook(page, 0,
 632                                                         PAGE_SIZE,
 633                                                         comp_bio, 0);
 634
 635                 page->mapping = NULL;
 636                 if (submit || bio_add_page(comp_bio, page, PAGE_SIZE, 0) <
 637                     PAGE_SIZE) {
 638                         bio_get(comp_bio);
 639
 640                         ret = btrfs_bio_wq_end_io(fs_info, comp_bio,
 641                                                   BTRFS_WQ_ENDIO_DATA);
 642                         BUG_ON(ret); /* -ENOMEM */
 643
 644                         /*
 645                          * inc the count before we submit the bio so
 646                          * we know the end IO handler won't happen before
 647                          * we inc the count.  Otherwise, the cb might get
 648                          * freed before we're done setting it up
 649                          */
 650                         refcount_inc(&cb->pending_bios);
 651
 652                         if (!(BTRFS_I(inode)->flags & BTRFS_INODE_NODATASUM)) {
 653                                 ret = btrfs_lookup_bio_sums(inode, comp_bio,
 654                                                             sums);
 655                                 BUG_ON(ret); /* -ENOMEM */
 656                         }
 657                         sums += DIV_ROUND_UP(comp_bio->bi_iter.bi_size,
 658                                              fs_info->sectorsize);
 659
 660                         ret = btrfs_map_bio(fs_info, comp_bio, mirror_num, 0);
 661                         if (ret) {
 662                                 comp_bio->bi_status = ret;
 663                                 bio_endio(comp_bio);
 664                         }
 665
 666                         bio_put(comp_bio);
 667
 668                         comp_bio = btrfs_bio_alloc(bdev, cur_disk_byte);
 669                         bio_set_op_attrs(comp_bio, REQ_OP_READ, 0);
 670                         comp_bio->bi_private = cb;
 671                         comp_bio->bi_end_io = end_compressed_bio_read;
 672
 673                         bio_add_page(comp_bio, page, PAGE_SIZE, 0);
 674                 }
 675                 cur_disk_byte += PAGE_SIZE;
 676         }
 677         bio_get(comp_bio);
 678
 679         ret = btrfs_bio_wq_end_io(fs_info, comp_bio, BTRFS_WQ_ENDIO_DATA);
 680         BUG_ON(ret); /* -ENOMEM */
 681
 682         if (!(BTRFS_I(inode)->flags & BTRFS_INODE_NODATASUM)) {
 683                 ret = btrfs_lookup_bio_sums(inode, comp_bio, sums);
 684                 BUG_ON(ret); /* -ENOMEM */
 685         }
 686
 687         ret = btrfs_map_bio(fs_info, comp_bio, mirror_num, 0);
 688         if (ret) {
 689                 comp_bio->bi_status = ret;
 690                 bio_endio(comp_bio);
 691         }
 692
 693         bio_put(comp_bio);
 694         return 0;
 695
 696 fail2:
 697         while (faili >= 0) {
 698                 __free_page(cb->compressed_pages[faili]);
 699                 faili--;
 700         }
 701
 702         kfree(cb->compressed_pages);
 703 fail1:
 704         kfree(cb);
 705 out:
 706         free_extent_map(em);
 707         return ret;
 708 }
 709
 710 static struct {
 711         struct list_head idle_ws;
 712         spinlock_t ws_lock;
 713         /* Number of free workspaces */
 714         int free_ws;
 715         /* Total number of allocated workspaces */
 716         atomic_t total_ws;
 717         /* Waiters for a free workspace */
 718         wait_queue_head_t ws_wait;
 719 } btrfs_comp_ws[BTRFS_COMPRESS_TYPES];
 720
 721 static const struct btrfs_compress_op * const btrfs_compress_op[] = {
 722         &btrfs_zlib_compress,
 723         &btrfs_lzo_compress,
 724         &btrfs_zstd_compress,
 725 };
 726
 727 void __init btrfs_init_compress(void)
 728 {
 729         int i;
 730
 731         for (i = 0; i < BTRFS_COMPRESS_TYPES; i++) {
 732                 struct list_head *workspace;
 733
 734                 INIT_LIST_HEAD(&btrfs_comp_ws[i].idle_ws);
 735                 spin_lock_init(&btrfs_comp_ws[i].ws_lock);
 736                 atomic_set(&btrfs_comp_ws[i].total_ws, 0);
 737                 init_waitqueue_head(&btrfs_comp_ws[i].ws_wait);
 738
 739                 /*
 740                  * Preallocate one workspace for each compression type so
 741                  * we can guarantee forward progress in the worst case
 742                  */
 743                 workspace = btrfs_compress_op[i]->alloc_workspace();
 744                 if (IS_ERR(workspace)) {
 745                         pr_warn("BTRFS: cannot preallocate compression workspace, will try later\n");
 746                 } else {
 747                         atomic_set(&btrfs_comp_ws[i].total_ws, 1);
 748                         btrfs_comp_ws[i].free_ws = 1;
 749                         list_add(workspace, &btrfs_comp_ws[i].idle_ws);
 750                 }
 751         }
 752 }
 753
 754 /*
 755  * This finds an available workspace or allocates a new one.
 756  * If it's not possible to allocate a new one, waits until there's one.
 757  * Preallocation makes a forward progress guarantees and we do not return
 758  * errors.
 759  */
 760 static struct list_head *find_workspace(int type)
 761 {
 762         struct list_head *workspace;
 763         int cpus = num_online_cpus();
 764         int idx = type - 1;
 765         unsigned nofs_flag;
 766
 767         struct list_head *idle_ws       = &btrfs_comp_ws[idx].idle_ws;
 768         spinlock_t *ws_lock             = &btrfs_comp_ws[idx].ws_lock;
 769         atomic_t *total_ws              = &btrfs_comp_ws[idx].total_ws;
 770         wait_queue_head_t *ws_wait      = &btrfs_comp_ws[idx].ws_wait;
 771         int *free_ws                    = &btrfs_comp_ws[idx].free_ws;
 772 again:
 773         spin_lock(ws_lock);
 774         if (!list_empty(idle_ws)) {
 775                 workspace = idle_ws->next;
 776                 list_del(workspace);
 777                 (*free_ws)--;
 778                 spin_unlock(ws_lock);
 779                 return workspace;
 780
 781         }
 782         if (atomic_read(total_ws) > cpus) {
 783                 DEFINE_WAIT(wait);
 784
 785                 spin_unlock(ws_lock);
 786                 prepare_to_wait(ws_wait, &wait, TASK_UNINTERRUPTIBLE);
 787                 if (atomic_read(total_ws) > cpus && !*free_ws)
 788                         schedule();
 789                 finish_wait(ws_wait, &wait);
 790                 goto again;
 791         }
 792         atomic_inc(total_ws);
 793         spin_unlock(ws_lock);
 794
 795         /*
 796          * Allocation helpers call vmalloc that can't use GFP_NOFS, so we have
 797          * to turn it off here because we might get called from the restricted
 798          * context of btrfs_compress_bio/btrfs_compress_pages
 799          */
 800         nofs_flag = memalloc_nofs_save();
 801         workspace = btrfs_compress_op[idx]->alloc_workspace();
 802         memalloc_nofs_restore(nofs_flag);
 803
 804         if (IS_ERR(workspace)) {
 805                 atomic_dec(total_ws);
 806                 wake_up(ws_wait);
 807
 808                 /*
 809                  * Do not return the error but go back to waiting. There's a
 810                  * workspace preallocated for each type and the compression
 811                  * time is bounded so we get to a workspace eventually. This
 812                  * makes our caller's life easier.
 813                  *
 814                  * To prevent silent and low-probability deadlocks (when the
 815                  * initial preallocation fails), check if there are any
 816                  * workspaces at all.
 817                  */
 818                 if (atomic_read(total_ws) == 0) {
 819                         static DEFINE_RATELIMIT_STATE(_rs,
 820                                         /* once per minute */ 60 * HZ,
 821                                         /* no burst */ 1);
 822
 823                         if (__ratelimit(&_rs)) {
 824                                 pr_warn("BTRFS: no compression workspaces, low memory, retrying\n");
 825                         }
 826                 }
 827                 goto again;
 828         }
 829         return workspace;
 830 }
 831
 832 /*
 833  * put a workspace struct back on the list or free it if we have enough
 834  * idle ones sitting around
 835  */
 836 static void free_workspace(int type, struct list_head *workspace)
 837 {
 838         int idx = type - 1;
 839         struct list_head *idle_ws       = &btrfs_comp_ws[idx].idle_ws;
 840         spinlock_t *ws_lock             = &btrfs_comp_ws[idx].ws_lock;
 841         atomic_t *total_ws              = &btrfs_comp_ws[idx].total_ws;
 842         wait_queue_head_t *ws_wait      = &btrfs_comp_ws[idx].ws_wait;
 843         int *free_ws                    = &btrfs_comp_ws[idx].free_ws;
 844
 845         spin_lock(ws_lock);
 846         if (*free_ws <= num_online_cpus()) {
 847                 list_add(workspace, idle_ws);
 848                 (*free_ws)++;
 849                 spin_unlock(ws_lock);
 850                 goto wake;
 851         }
 852         spin_unlock(ws_lock);
 853
 854         btrfs_compress_op[idx]->free_workspace(workspace);
 855         atomic_dec(total_ws);
 856 wake:
 857         /*
 858          * Make sure counter is updated before we wake up waiters.
 859          */
 860         smp_mb();
 861         if (waitqueue_active(ws_wait))
 862                 wake_up(ws_wait);
 863 }
 864
 865 /*
 866  * cleanup function for module exit
 867  */
 868 static void free_workspaces(void)
 869 {
 870         struct list_head *workspace;
 871         int i;
 872
 873         for (i = 0; i < BTRFS_COMPRESS_TYPES; i++) {
 874                 while (!list_empty(&btrfs_comp_ws[i].idle_ws)) {
 875                         workspace = btrfs_comp_ws[i].idle_ws.next;
 876                         list_del(workspace);
 877                         btrfs_compress_op[i]->free_workspace(workspace);
 878                         atomic_dec(&btrfs_comp_ws[i].total_ws);
 879                 }
 880         }
 881 }
 882
 883 /*
 884  * Given an address space and start and length, compress the bytes into @pages
 885  * that are allocated on demand.
 886  *
 887  * @type_level is encoded algorithm and level, where level 0 means whatever
 888  * default the algorithm chooses and is opaque here;
 889  * - compression algo are 0-3
 890  * - the level are bits 4-7
 891  *
 892  * @out_pages is an in/out parameter, holds maximum number of pages to allocate
 893  * and returns number of actually allocated pages
 894  *
 895  * @total_in is used to return the number of bytes actually read.  It
 896  * may be smaller than the input length if we had to exit early because we
 897  * ran out of room in the pages array or because we cross the
 898  * max_out threshold.
 899  *
 900  * @total_out is an in/out parameter, must be set to the input length and will
 901  * be also used to return the total number of compressed bytes
 902  *
 903  * @max_out tells us the max number of bytes that we're allowed to
 904  * stuff into pages
 905  */
 906 int btrfs_compress_pages(unsigned int type_level, struct address_space *mapping,
 907                          u64 start, struct page **pages,
 908                          unsigned long *out_pages,
 909                          unsigned long *total_in,
 910                          unsigned long *total_out)
 911 {
 912         struct list_head *workspace;
 913         int ret;
 914         int type = type_level & 0xF;
 915
 916         workspace = find_workspace(type);
 917
 918         btrfs_compress_op[type - 1]->set_level(workspace, type_level);
 919         ret = btrfs_compress_op[type-1]->compress_pages(workspace, mapping,
 920                                                       start, pages,
 921                                                       out_pages,
 922                                                       total_in, total_out);
 923         free_workspace(type, workspace);
 924         return ret;
 925 }
 926
 927 /*
 928  * pages_in is an array of pages with compressed data.
 929  *
 930  * disk_start is the starting logical offset of this array in the file
 931  *
 932  * orig_bio contains the pages from the file that we want to decompress into
 933  *
 934  * srclen is the number of bytes in pages_in
 935  *
 936  * The basic idea is that we have a bio that was created by readpages.
 937  * The pages in the bio are for the uncompressed data, and they may not
 938  * be contiguous.  They all correspond to the range of bytes covered by
 939  * the compressed extent.
 940  */
 941 static int btrfs_decompress_bio(struct compressed_bio *cb)
 942 {
 943         struct list_head *workspace;
 944         int ret;
 945         int type = cb->compress_type;
 946
 947         workspace = find_workspace(type);
 948         ret = btrfs_compress_op[type - 1]->decompress_bio(workspace, cb);
 949         free_workspace(type, workspace);
 950
 951         return ret;
 952 }
 953
 954 /*
 955  * a less complex decompression routine.  Our compressed data fits in a
 956  * single page, and we want to read a single page out of it.
 957  * start_byte tells us the offset into the compressed data we're interested in
 958  */
 959 int btrfs_decompress(int type, unsigned char *data_in, struct page *dest_page,
 960                      unsigned long start_byte, size_t srclen, size_t destlen)
 961 {
 962         struct list_head *workspace;
 963         int ret;
 964
 965         workspace = find_workspace(type);
 966
 967         ret = btrfs_compress_op[type-1]->decompress(workspace, data_in,
 968                                                   dest_page, start_byte,
 969                                                   srclen, destlen);
 970
 971         free_workspace(type, workspace);
 972         return ret;
 973 }
 974
 975 void btrfs_exit_compress(void)
 976 {
 977         free_workspaces();
 978 }
 979
 980 /*
 981  * Copy uncompressed data from working buffer to pages.
 982  *
 983  * buf_start is the byte offset we're of the start of our workspace buffer.
 984  *
 985  * total_out is the last byte of the buffer
 986  */
 987 int btrfs_decompress_buf2page(const char *buf, unsigned long buf_start,
 988                               unsigned long total_out, u64 disk_start,
 989                               struct bio *bio)
 990 {
 991         unsigned long buf_offset;
 992         unsigned long current_buf_start;
 993         unsigned long start_byte;
 994         unsigned long prev_start_byte;
 995         unsigned long working_bytes = total_out - buf_start;
 996         unsigned long bytes;
 997         char *kaddr;
 998         struct bio_vec bvec = bio_iter_iovec(bio, bio->bi_iter);
 999
1000         /*
1001          * start byte is the first byte of the page we're currently
1002          * copying into relative to the start of the compressed data.
1003          */
1004         start_byte = page_offset(bvec.bv_page) - disk_start;
1005
1006         /* we haven't yet hit data corresponding to this page */
1007         if (total_out <= start_byte)
1008                 return 1;
1009
1010         /*
1011          * the start of the data we care about is offset into
1012          * the middle of our working buffer
1013          */
1014         if (total_out > start_byte && buf_start < start_byte) {
1015                 buf_offset = start_byte - buf_start;
1016                 working_bytes -= buf_offset;
1017         } else {
1018                 buf_offset = 0;
1019         }
1020         current_buf_start = buf_start;
1021
1022         /* copy bytes from the working buffer into the pages */
1023         while (working_bytes > 0) {
1024                 bytes = min_t(unsigned long, bvec.bv_len,
1025                                 PAGE_SIZE - buf_offset);
1026                 bytes = min(bytes, working_bytes);
1027
1028                 kaddr = kmap_atomic(bvec.bv_page);
1029                 memcpy(kaddr + bvec.bv_offset, buf + buf_offset, bytes);
1030                 kunmap_atomic(kaddr);
1031                 flush_dcache_page(bvec.bv_page);
1032
1033                 buf_offset += bytes;
1034                 working_bytes -= bytes;
1035                 current_buf_start += bytes;
1036
1037                 /* check if we need to pick another page */
1038                 bio_advance(bio, bytes);
1039                 if (!bio->bi_iter.bi_size)
1040                         return 0;
1041                 bvec = bio_iter_iovec(bio, bio->bi_iter);
1042                 prev_start_byte = start_byte;
1043                 start_byte = page_offset(bvec.bv_page) - disk_start;
1044
1045                 /*
1046                  * We need to make sure we're only adjusting
1047                  * our offset into compression working buffer when
1048                  * we're switching pages.  Otherwise we can incorrectly
1049                  * keep copying when we were actually done.
1050                  */
1051                 if (start_byte != prev_start_byte) {
1052                         /*
1053                          * make sure our new page is covered by this
1054                          * working buffer
1055                          */
1056                         if (total_out <= start_byte)
1057                                 return 1;
1058
1059                         /*
1060                          * the next page in the biovec might not be adjacent
1061                          * to the last page, but it might still be found
1062                          * inside this working buffer. bump our offset pointer
1063                          */
1064                         if (total_out > start_byte &&
1065                             current_buf_start < start_byte) {
1066                                 buf_offset = start_byte - buf_start;
1067                                 working_bytes = total_out - start_byte;
1068                                 current_buf_start = buf_start + buf_offset;
1069                         }
1070                 }
1071         }
1072
1073         return 1;
1074 }
1075
1076 /*
1077  * Compression heuristic.
1078  *
1079  * For now is's a naive and optimistic 'return true', we'll extend the logic to
1080  * quickly (compared to direct compression) detect data characteristics
1081  * (compressible/uncompressible) to avoid wasting CPU time on uncompressible
1082  * data.
1083  *
1084  * The following types of analysis can be performed:
1085  * - detect mostly zero data
1086  * - detect data with low "byte set" size (text, etc)
1087  * - detect data with low/high "core byte" set
1088  *
1089  * Return non-zero if the compression should be done, 0 otherwise.
1090  */
1091 int btrfs_compress_heuristic(struct inode *inode, u64 start, u64 end)
1092 {
1093         u64 index = start >> PAGE_SHIFT;
1094         u64 end_index = end >> PAGE_SHIFT;
1095         struct page *page;
1096         int ret = 1;
1097
1098         while (index <= end_index) {
1099                 page = find_get_page(inode->i_mapping, index);
1100                 kmap(page);
1101                 kunmap(page);
1102                 put_page(page);
1103                 index++;
1104         }
1105
1106         return ret;
1107 }
1108
1109 unsigned int btrfs_compress_str2level(const char *str)
1110 {
1111         if (strncmp(str, "zlib", 4) != 0)
1112                 return 0;
1113
1114         if ('1' <= str[4] && str[4] <= '9' )
1115                 return str[4] - '0';
1116
1117         return 0;
1118 }