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