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 | |
50343883 | 9 | #include <linux/blk_types.h> |
d5c1d68f QW |
10 | #include <linux/sizes.h> |
11 | ||
c7ee1819 NB |
12 | struct btrfs_inode; |
13 | ||
ff763866 DS |
14 | /* |
15 | * We want to make sure that amount of RAM required to uncompress an extent is | |
16 | * reasonable, so we limit the total size in ram of a compressed extent to | |
17 | * 128k. This is a crucial number because it also controls how easily we can | |
18 | * spread reads across cpus for decompression. | |
19 | * | |
20 | * We also want to make sure the amount of IO required to do a random read is | |
21 | * reasonably small, so we limit the size of a compressed extent to 128k. | |
22 | */ | |
23 | ||
24 | /* Maximum length of compressed data stored on disk */ | |
25 | #define BTRFS_MAX_COMPRESSED (SZ_128K) | |
a55e65b8 DS |
26 | static_assert((BTRFS_MAX_COMPRESSED % PAGE_SIZE) == 0); |
27 | ||
ff763866 DS |
28 | /* Maximum size of data before compression */ |
29 | #define BTRFS_MAX_UNCOMPRESSED (SZ_128K) | |
30 | ||
eae8d825 QW |
31 | #define BTRFS_ZLIB_DEFAULT_LEVEL 3 |
32 | ||
e1ddce71 | 33 | struct compressed_bio { |
282ab3ff DS |
34 | /* Number of compressed pages in the array */ |
35 | unsigned int nr_pages; | |
36 | ||
e1ddce71 AJ |
37 | /* the pages with the compressed data on them */ |
38 | struct page **compressed_pages; | |
39 | ||
40 | /* inode that owns this data */ | |
41 | struct inode *inode; | |
42 | ||
43 | /* starting offset in the inode for our pages */ | |
44 | u64 start; | |
45 | ||
282ab3ff DS |
46 | /* Number of bytes in the inode we're working on */ |
47 | unsigned int len; | |
e1ddce71 | 48 | |
282ab3ff DS |
49 | /* Number of bytes on disk */ |
50 | unsigned int compressed_len; | |
e1ddce71 | 51 | |
282ab3ff DS |
52 | /* The compression algorithm for this bio */ |
53 | u8 compress_type; | |
e1ddce71 | 54 | |
7c0c7269 OS |
55 | /* Whether this is a write for writeback. */ |
56 | bool writeback; | |
57 | ||
e1ddce71 | 58 | /* IO errors */ |
606f82e7 | 59 | blk_status_t status; |
e1ddce71 | 60 | |
fed8a72d CH |
61 | union { |
62 | /* For reads, this is the bio we are copying the data into */ | |
63 | struct bio *orig_bio; | |
64 | struct work_struct write_end_work; | |
65 | }; | |
e1ddce71 AJ |
66 | }; |
67 | ||
1972708a DZ |
68 | static inline unsigned int btrfs_compress_type(unsigned int type_level) |
69 | { | |
70 | return (type_level & 0xF); | |
71 | } | |
72 | ||
73 | static inline unsigned int btrfs_compress_level(unsigned int type_level) | |
74 | { | |
75 | return ((type_level & 0xF0) >> 4); | |
76 | } | |
77 | ||
5565b8e0 | 78 | int __init btrfs_init_compress(void); |
e67c718b | 79 | void __cold btrfs_exit_compress(void); |
261507a0 | 80 | |
f51d2b59 | 81 | int btrfs_compress_pages(unsigned int type_level, struct address_space *mapping, |
38c31464 | 82 | u64 start, struct page **pages, |
261507a0 LZ |
83 | unsigned long *out_pages, |
84 | unsigned long *total_in, | |
e5d74902 | 85 | unsigned long *total_out); |
3e09b5b2 | 86 | int btrfs_decompress(int type, const u8 *data_in, struct page *dest_page, |
261507a0 | 87 | unsigned long start_byte, size_t srclen, size_t destlen); |
1c3dc173 QW |
88 | int btrfs_decompress_buf2page(const char *buf, u32 buf_len, |
89 | struct compressed_bio *cb, u32 decompressed); | |
261507a0 | 90 | |
c7ee1819 | 91 | blk_status_t btrfs_submit_compressed_write(struct btrfs_inode *inode, u64 start, |
65b5355f AJ |
92 | unsigned int len, u64 disk_start, |
93 | unsigned int compressed_len, | |
c8b97818 | 94 | struct page **compressed_pages, |
65b5355f | 95 | unsigned int nr_pages, |
bf9486d6 | 96 | blk_opf_t write_flags, |
7c0c7269 OS |
97 | struct cgroup_subsys_state *blkcg_css, |
98 | bool writeback); | |
cb4411dd | 99 | void btrfs_submit_compressed_read(struct inode *inode, struct bio *bio, |
1d8fa2e2 | 100 | int mirror_num); |
ebb8765b | 101 | |
d0ab62ce | 102 | unsigned int btrfs_compress_str2level(unsigned int type, const char *str); |
f51d2b59 | 103 | |
ebb8765b AJ |
104 | enum btrfs_compression_type { |
105 | BTRFS_COMPRESS_NONE = 0, | |
106 | BTRFS_COMPRESS_ZLIB = 1, | |
107 | BTRFS_COMPRESS_LZO = 2, | |
5c1aab1d | 108 | BTRFS_COMPRESS_ZSTD = 3, |
ce96b7ff | 109 | BTRFS_NR_COMPRESS_TYPES = 4, |
ebb8765b AJ |
110 | }; |
111 | ||
92ee5530 | 112 | struct workspace_manager { |
92ee5530 DZ |
113 | struct list_head idle_ws; |
114 | spinlock_t ws_lock; | |
115 | /* Number of free workspaces */ | |
116 | int free_ws; | |
117 | /* Total number of allocated workspaces */ | |
118 | atomic_t total_ws; | |
119 | /* Waiters for a free workspace */ | |
120 | wait_queue_head_t ws_wait; | |
121 | }; | |
122 | ||
5907a9bb | 123 | struct list_head *btrfs_get_workspace(int type, unsigned int level); |
a3bbd2a9 | 124 | void btrfs_put_workspace(int type, struct list_head *ws); |
92ee5530 | 125 | |
261507a0 | 126 | struct btrfs_compress_op { |
be951045 | 127 | struct workspace_manager *workspace_manager; |
e18333a7 DS |
128 | /* Maximum level supported by the compression algorithm */ |
129 | unsigned int max_level; | |
130 | unsigned int default_level; | |
261507a0 LZ |
131 | }; |
132 | ||
ca4ac360 | 133 | /* The heuristic workspaces are managed via the 0th workspace manager */ |
ce96b7ff | 134 | #define BTRFS_NR_WORKSPACE_MANAGERS BTRFS_NR_COMPRESS_TYPES |
ca4ac360 DZ |
135 | |
136 | extern const struct btrfs_compress_op btrfs_heuristic_compress; | |
e8c9f186 DS |
137 | extern const struct btrfs_compress_op btrfs_zlib_compress; |
138 | extern const struct btrfs_compress_op btrfs_lzo_compress; | |
5c1aab1d | 139 | extern const struct btrfs_compress_op btrfs_zstd_compress; |
261507a0 | 140 | |
e128f9c3 | 141 | const char* btrfs_compress_type2str(enum btrfs_compression_type type); |
aa53e3bf | 142 | bool btrfs_compress_is_valid_type(const char *str, size_t len); |
e128f9c3 | 143 | |
c2fcdcdf TT |
144 | int btrfs_compress_heuristic(struct inode *inode, u64 start, u64 end); |
145 | ||
cb4c9198 DS |
146 | int zlib_compress_pages(struct list_head *ws, struct address_space *mapping, |
147 | u64 start, struct page **pages, unsigned long *out_pages, | |
148 | unsigned long *total_in, unsigned long *total_out); | |
149 | int zlib_decompress_bio(struct list_head *ws, struct compressed_bio *cb); | |
3e09b5b2 | 150 | int zlib_decompress(struct list_head *ws, const u8 *data_in, |
cb4c9198 DS |
151 | struct page *dest_page, unsigned long start_byte, size_t srclen, |
152 | size_t destlen); | |
153 | struct list_head *zlib_alloc_workspace(unsigned int level); | |
154 | void zlib_free_workspace(struct list_head *ws); | |
155 | struct list_head *zlib_get_workspace(unsigned int level); | |
156 | ||
157 | int lzo_compress_pages(struct list_head *ws, struct address_space *mapping, | |
158 | u64 start, struct page **pages, unsigned long *out_pages, | |
159 | unsigned long *total_in, unsigned long *total_out); | |
160 | int lzo_decompress_bio(struct list_head *ws, struct compressed_bio *cb); | |
3e09b5b2 | 161 | int lzo_decompress(struct list_head *ws, const u8 *data_in, |
cb4c9198 DS |
162 | struct page *dest_page, unsigned long start_byte, size_t srclen, |
163 | size_t destlen); | |
164 | struct list_head *lzo_alloc_workspace(unsigned int level); | |
165 | void lzo_free_workspace(struct list_head *ws); | |
166 | ||
167 | int zstd_compress_pages(struct list_head *ws, struct address_space *mapping, | |
168 | u64 start, struct page **pages, unsigned long *out_pages, | |
169 | unsigned long *total_in, unsigned long *total_out); | |
170 | int zstd_decompress_bio(struct list_head *ws, struct compressed_bio *cb); | |
3e09b5b2 | 171 | int zstd_decompress(struct list_head *ws, const u8 *data_in, |
cb4c9198 DS |
172 | struct page *dest_page, unsigned long start_byte, size_t srclen, |
173 | size_t destlen); | |
174 | void zstd_init_workspace_manager(void); | |
175 | void zstd_cleanup_workspace_manager(void); | |
176 | struct list_head *zstd_alloc_workspace(unsigned int level); | |
177 | void zstd_free_workspace(struct list_head *ws); | |
178 | struct list_head *zstd_get_workspace(unsigned int level); | |
179 | void zstd_put_workspace(struct list_head *ws); | |
180 | ||
c8b97818 | 181 | #endif |