]>
Commit | Line | Data |
---|---|---|
9888c340 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
c8b97818 CM |
2 | /* |
3 | * Copyright (C) 2008 Oracle. All rights reserved. | |
c8b97818 CM |
4 | */ |
5 | ||
9888c340 DS |
6 | #ifndef BTRFS_COMPRESSION_H |
7 | #define BTRFS_COMPRESSION_H | |
c8b97818 | 8 | |
d5c1d68f QW |
9 | #include <linux/sizes.h> |
10 | ||
ff763866 DS |
11 | /* |
12 | * We want to make sure that amount of RAM required to uncompress an extent is | |
13 | * reasonable, so we limit the total size in ram of a compressed extent to | |
14 | * 128k. This is a crucial number because it also controls how easily we can | |
15 | * spread reads across cpus for decompression. | |
16 | * | |
17 | * We also want to make sure the amount of IO required to do a random read is | |
18 | * reasonably small, so we limit the size of a compressed extent to 128k. | |
19 | */ | |
20 | ||
21 | /* Maximum length of compressed data stored on disk */ | |
22 | #define BTRFS_MAX_COMPRESSED (SZ_128K) | |
23 | /* Maximum size of data before compression */ | |
24 | #define BTRFS_MAX_UNCOMPRESSED (SZ_128K) | |
25 | ||
eae8d825 QW |
26 | #define BTRFS_ZLIB_DEFAULT_LEVEL 3 |
27 | ||
e1ddce71 AJ |
28 | struct compressed_bio { |
29 | /* number of bios pending for this compressed extent */ | |
30 | refcount_t pending_bios; | |
31 | ||
32 | /* the pages with the compressed data on them */ | |
33 | struct page **compressed_pages; | |
34 | ||
35 | /* inode that owns this data */ | |
36 | struct inode *inode; | |
37 | ||
38 | /* starting offset in the inode for our pages */ | |
39 | u64 start; | |
40 | ||
41 | /* number of bytes in the inode we're working on */ | |
42 | unsigned long len; | |
43 | ||
44 | /* number of bytes on disk */ | |
45 | unsigned long compressed_len; | |
46 | ||
47 | /* the compression algorithm for this bio */ | |
48 | int compress_type; | |
49 | ||
50 | /* number of compressed pages in the array */ | |
51 | unsigned long nr_pages; | |
52 | ||
53 | /* IO errors */ | |
54 | int errors; | |
55 | int mirror_num; | |
56 | ||
57 | /* for reads, this is the bio we are copying the data into */ | |
58 | struct bio *orig_bio; | |
59 | ||
60 | /* | |
61 | * the start of a variable length array of checksums only | |
62 | * used by reads | |
63 | */ | |
10fe6ca8 | 64 | u8 sums[]; |
e1ddce71 AJ |
65 | }; |
66 | ||
1972708a DZ |
67 | static inline unsigned int btrfs_compress_type(unsigned int type_level) |
68 | { | |
69 | return (type_level & 0xF); | |
70 | } | |
71 | ||
72 | static inline unsigned int btrfs_compress_level(unsigned int type_level) | |
73 | { | |
74 | return ((type_level & 0xF0) >> 4); | |
75 | } | |
76 | ||
f5c29bd9 | 77 | void __init btrfs_init_compress(void); |
e67c718b | 78 | void __cold btrfs_exit_compress(void); |
261507a0 | 79 | |
f51d2b59 | 80 | int btrfs_compress_pages(unsigned int type_level, struct address_space *mapping, |
38c31464 | 81 | u64 start, struct page **pages, |
261507a0 LZ |
82 | unsigned long *out_pages, |
83 | unsigned long *total_in, | |
e5d74902 | 84 | unsigned long *total_out); |
261507a0 LZ |
85 | int btrfs_decompress(int type, unsigned char *data_in, struct page *dest_page, |
86 | unsigned long start_byte, size_t srclen, size_t destlen); | |
14a3357b | 87 | int btrfs_decompress_buf2page(const char *buf, unsigned long buf_start, |
3a39c18d | 88 | unsigned long total_out, u64 disk_start, |
974b1adc | 89 | struct bio *bio); |
261507a0 | 90 | |
4e4cbee9 | 91 | blk_status_t btrfs_submit_compressed_write(struct inode *inode, u64 start, |
c8b97818 CM |
92 | unsigned long len, u64 disk_start, |
93 | unsigned long compressed_len, | |
94 | struct page **compressed_pages, | |
f82b7359 | 95 | unsigned long nr_pages, |
ec39f769 CM |
96 | unsigned int write_flags, |
97 | struct cgroup_subsys_state *blkcg_css); | |
4e4cbee9 | 98 | blk_status_t btrfs_submit_compressed_read(struct inode *inode, struct bio *bio, |
c8b97818 | 99 | int mirror_num, unsigned long bio_flags); |
ebb8765b | 100 | |
d0ab62ce | 101 | unsigned int btrfs_compress_str2level(unsigned int type, const char *str); |
f51d2b59 | 102 | |
ebb8765b AJ |
103 | enum btrfs_compression_type { |
104 | BTRFS_COMPRESS_NONE = 0, | |
105 | BTRFS_COMPRESS_ZLIB = 1, | |
106 | BTRFS_COMPRESS_LZO = 2, | |
5c1aab1d | 107 | BTRFS_COMPRESS_ZSTD = 3, |
ce96b7ff | 108 | BTRFS_NR_COMPRESS_TYPES = 4, |
ebb8765b AJ |
109 | }; |
110 | ||
92ee5530 | 111 | struct workspace_manager { |
92ee5530 DZ |
112 | struct list_head idle_ws; |
113 | spinlock_t ws_lock; | |
114 | /* Number of free workspaces */ | |
115 | int free_ws; | |
116 | /* Total number of allocated workspaces */ | |
117 | atomic_t total_ws; | |
118 | /* Waiters for a free workspace */ | |
119 | wait_queue_head_t ws_wait; | |
120 | }; | |
121 | ||
5907a9bb | 122 | struct list_head *btrfs_get_workspace(int type, unsigned int level); |
a3bbd2a9 | 123 | void btrfs_put_workspace(int type, struct list_head *ws); |
92ee5530 | 124 | |
261507a0 | 125 | struct btrfs_compress_op { |
be951045 | 126 | struct workspace_manager *workspace_manager; |
e18333a7 DS |
127 | /* Maximum level supported by the compression algorithm */ |
128 | unsigned int max_level; | |
129 | unsigned int default_level; | |
261507a0 LZ |
130 | }; |
131 | ||
ca4ac360 | 132 | /* The heuristic workspaces are managed via the 0th workspace manager */ |
ce96b7ff | 133 | #define BTRFS_NR_WORKSPACE_MANAGERS BTRFS_NR_COMPRESS_TYPES |
ca4ac360 DZ |
134 | |
135 | extern const struct btrfs_compress_op btrfs_heuristic_compress; | |
e8c9f186 DS |
136 | extern const struct btrfs_compress_op btrfs_zlib_compress; |
137 | extern const struct btrfs_compress_op btrfs_lzo_compress; | |
5c1aab1d | 138 | extern const struct btrfs_compress_op btrfs_zstd_compress; |
261507a0 | 139 | |
e128f9c3 | 140 | const char* btrfs_compress_type2str(enum btrfs_compression_type type); |
aa53e3bf | 141 | bool btrfs_compress_is_valid_type(const char *str, size_t len); |
e128f9c3 | 142 | |
b0c1fe1e DS |
143 | unsigned int btrfs_compress_set_level(int type, unsigned level); |
144 | ||
c2fcdcdf TT |
145 | int btrfs_compress_heuristic(struct inode *inode, u64 start, u64 end); |
146 | ||
c8b97818 | 147 | #endif |