Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright (C) 2008 Oracle. All rights reserved.
4 */
5
6#ifndef BTRFS_COMPRESSION_H
7#define BTRFS_COMPRESSION_H
8
9#include <linux/blk_types.h>
10#include <linux/sizes.h>
11
12struct btrfs_inode;
13
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)
26static_assert((BTRFS_MAX_COMPRESSED % PAGE_SIZE) == 0);
27
28/* Maximum size of data before compression */
29#define BTRFS_MAX_UNCOMPRESSED (SZ_128K)
30
31#define BTRFS_ZLIB_DEFAULT_LEVEL 3
32
33struct compressed_bio {
34 /* Number of outstanding bios */
35 refcount_t pending_ios;
36
37 /* Number of compressed pages in the array */
38 unsigned int nr_pages;
39
40 /* the pages with the compressed data on them */
41 struct page **compressed_pages;
42
43 /* inode that owns this data */
44 struct inode *inode;
45
46 /* starting offset in the inode for our pages */
47 u64 start;
48
49 /* Number of bytes in the inode we're working on */
50 unsigned int len;
51
52 /* Number of bytes on disk */
53 unsigned int compressed_len;
54
55 /* The compression algorithm for this bio */
56 u8 compress_type;
57
58 /* Whether this is a write for writeback. */
59 bool writeback;
60
61 /* IO errors */
62 blk_status_t status;
63
64 union {
65 /* For reads, this is the bio we are copying the data into */
66 struct bio *orig_bio;
67 struct work_struct write_end_work;
68 };
69};
70
71static inline unsigned int btrfs_compress_type(unsigned int type_level)
72{
73 return (type_level & 0xF);
74}
75
76static inline unsigned int btrfs_compress_level(unsigned int type_level)
77{
78 return ((type_level & 0xF0) >> 4);
79}
80
81int __init btrfs_init_compress(void);
82void __cold btrfs_exit_compress(void);
83
84int btrfs_compress_pages(unsigned int type_level, struct address_space *mapping,
85 u64 start, struct page **pages,
86 unsigned long *out_pages,
87 unsigned long *total_in,
88 unsigned long *total_out);
89int btrfs_decompress(int type, const u8 *data_in, struct page *dest_page,
90 unsigned long start_byte, size_t srclen, size_t destlen);
91int btrfs_decompress_buf2page(const char *buf, u32 buf_len,
92 struct compressed_bio *cb, u32 decompressed);
93
94blk_status_t btrfs_submit_compressed_write(struct btrfs_inode *inode, u64 start,
95 unsigned int len, u64 disk_start,
96 unsigned int compressed_len,
97 struct page **compressed_pages,
98 unsigned int nr_pages,
99 blk_opf_t write_flags,
100 struct cgroup_subsys_state *blkcg_css,
101 bool writeback);
102void btrfs_submit_compressed_read(struct inode *inode, struct bio *bio,
103 int mirror_num);
104
105unsigned int btrfs_compress_str2level(unsigned int type, const char *str);
106
107enum btrfs_compression_type {
108 BTRFS_COMPRESS_NONE = 0,
109 BTRFS_COMPRESS_ZLIB = 1,
110 BTRFS_COMPRESS_LZO = 2,
111 BTRFS_COMPRESS_ZSTD = 3,
112 BTRFS_NR_COMPRESS_TYPES = 4,
113};
114
115struct workspace_manager {
116 struct list_head idle_ws;
117 spinlock_t ws_lock;
118 /* Number of free workspaces */
119 int free_ws;
120 /* Total number of allocated workspaces */
121 atomic_t total_ws;
122 /* Waiters for a free workspace */
123 wait_queue_head_t ws_wait;
124};
125
126struct list_head *btrfs_get_workspace(int type, unsigned int level);
127void btrfs_put_workspace(int type, struct list_head *ws);
128
129struct btrfs_compress_op {
130 struct workspace_manager *workspace_manager;
131 /* Maximum level supported by the compression algorithm */
132 unsigned int max_level;
133 unsigned int default_level;
134};
135
136/* The heuristic workspaces are managed via the 0th workspace manager */
137#define BTRFS_NR_WORKSPACE_MANAGERS BTRFS_NR_COMPRESS_TYPES
138
139extern const struct btrfs_compress_op btrfs_heuristic_compress;
140extern const struct btrfs_compress_op btrfs_zlib_compress;
141extern const struct btrfs_compress_op btrfs_lzo_compress;
142extern const struct btrfs_compress_op btrfs_zstd_compress;
143
144const char* btrfs_compress_type2str(enum btrfs_compression_type type);
145bool btrfs_compress_is_valid_type(const char *str, size_t len);
146
147int btrfs_compress_heuristic(struct inode *inode, u64 start, u64 end);
148
149int zlib_compress_pages(struct list_head *ws, struct address_space *mapping,
150 u64 start, struct page **pages, unsigned long *out_pages,
151 unsigned long *total_in, unsigned long *total_out);
152int zlib_decompress_bio(struct list_head *ws, struct compressed_bio *cb);
153int zlib_decompress(struct list_head *ws, const u8 *data_in,
154 struct page *dest_page, unsigned long start_byte, size_t srclen,
155 size_t destlen);
156struct list_head *zlib_alloc_workspace(unsigned int level);
157void zlib_free_workspace(struct list_head *ws);
158struct list_head *zlib_get_workspace(unsigned int level);
159
160int lzo_compress_pages(struct list_head *ws, struct address_space *mapping,
161 u64 start, struct page **pages, unsigned long *out_pages,
162 unsigned long *total_in, unsigned long *total_out);
163int lzo_decompress_bio(struct list_head *ws, struct compressed_bio *cb);
164int lzo_decompress(struct list_head *ws, const u8 *data_in,
165 struct page *dest_page, unsigned long start_byte, size_t srclen,
166 size_t destlen);
167struct list_head *lzo_alloc_workspace(unsigned int level);
168void lzo_free_workspace(struct list_head *ws);
169
170int zstd_compress_pages(struct list_head *ws, struct address_space *mapping,
171 u64 start, struct page **pages, unsigned long *out_pages,
172 unsigned long *total_in, unsigned long *total_out);
173int zstd_decompress_bio(struct list_head *ws, struct compressed_bio *cb);
174int zstd_decompress(struct list_head *ws, const u8 *data_in,
175 struct page *dest_page, unsigned long start_byte, size_t srclen,
176 size_t destlen);
177void zstd_init_workspace_manager(void);
178void zstd_cleanup_workspace_manager(void);
179struct list_head *zstd_alloc_workspace(unsigned int level);
180void zstd_free_workspace(struct list_head *ws);
181struct list_head *zstd_get_workspace(unsigned int level);
182void zstd_put_workspace(struct list_head *ws);
183
184#endif
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright (C) 2008 Oracle. All rights reserved.
4 */
5
6#ifndef BTRFS_COMPRESSION_H
7#define BTRFS_COMPRESSION_H
8
9#include <linux/sizes.h>
10#include <linux/mm.h>
11#include <linux/list.h>
12#include <linux/workqueue.h>
13#include <linux/wait.h>
14#include "bio.h"
15
16struct address_space;
17struct page;
18struct inode;
19struct btrfs_inode;
20struct btrfs_ordered_extent;
21struct btrfs_bio;
22
23/*
24 * We want to make sure that amount of RAM required to uncompress an extent is
25 * reasonable, so we limit the total size in ram of a compressed extent to
26 * 128k. This is a crucial number because it also controls how easily we can
27 * spread reads across cpus for decompression.
28 *
29 * We also want to make sure the amount of IO required to do a random read is
30 * reasonably small, so we limit the size of a compressed extent to 128k.
31 */
32
33/* Maximum length of compressed data stored on disk */
34#define BTRFS_MAX_COMPRESSED (SZ_128K)
35#define BTRFS_MAX_COMPRESSED_PAGES (BTRFS_MAX_COMPRESSED / PAGE_SIZE)
36static_assert((BTRFS_MAX_COMPRESSED % PAGE_SIZE) == 0);
37
38/* Maximum size of data before compression */
39#define BTRFS_MAX_UNCOMPRESSED (SZ_128K)
40
41#define BTRFS_ZLIB_DEFAULT_LEVEL 3
42
43struct compressed_bio {
44 /* Number of compressed folios in the array. */
45 unsigned int nr_folios;
46
47 /* The folios with the compressed data on them. */
48 struct folio **compressed_folios;
49
50 /* starting offset in the inode for our pages */
51 u64 start;
52
53 /* Number of bytes in the inode we're working on */
54 unsigned int len;
55
56 /* Number of bytes on disk */
57 unsigned int compressed_len;
58
59 /* The compression algorithm for this bio */
60 u8 compress_type;
61
62 /* Whether this is a write for writeback. */
63 bool writeback;
64
65 union {
66 /* For reads, this is the bio we are copying the data into */
67 struct btrfs_bio *orig_bbio;
68 struct work_struct write_end_work;
69 };
70
71 /* Must be last. */
72 struct btrfs_bio bbio;
73};
74
75static inline unsigned int btrfs_compress_type(unsigned int type_level)
76{
77 return (type_level & 0xF);
78}
79
80static inline unsigned int btrfs_compress_level(unsigned int type_level)
81{
82 return ((type_level & 0xF0) >> 4);
83}
84
85/* @range_end must be exclusive. */
86static inline u32 btrfs_calc_input_length(u64 range_end, u64 cur)
87{
88 u64 page_end = round_down(cur, PAGE_SIZE) + PAGE_SIZE;
89
90 return min(range_end, page_end) - cur;
91}
92
93int __init btrfs_init_compress(void);
94void __cold btrfs_exit_compress(void);
95
96int btrfs_compress_folios(unsigned int type_level, struct address_space *mapping,
97 u64 start, struct folio **folios, unsigned long *out_folios,
98 unsigned long *total_in, unsigned long *total_out);
99int btrfs_decompress(int type, const u8 *data_in, struct folio *dest_folio,
100 unsigned long start_byte, size_t srclen, size_t destlen);
101int btrfs_decompress_buf2page(const char *buf, u32 buf_len,
102 struct compressed_bio *cb, u32 decompressed);
103
104void btrfs_submit_compressed_write(struct btrfs_ordered_extent *ordered,
105 struct folio **compressed_folios,
106 unsigned int nr_folios, blk_opf_t write_flags,
107 bool writeback);
108void btrfs_submit_compressed_read(struct btrfs_bio *bbio);
109
110unsigned int btrfs_compress_str2level(unsigned int type, const char *str);
111
112struct folio *btrfs_alloc_compr_folio(void);
113void btrfs_free_compr_folio(struct folio *folio);
114
115enum btrfs_compression_type {
116 BTRFS_COMPRESS_NONE = 0,
117 BTRFS_COMPRESS_ZLIB = 1,
118 BTRFS_COMPRESS_LZO = 2,
119 BTRFS_COMPRESS_ZSTD = 3,
120 BTRFS_NR_COMPRESS_TYPES = 4,
121};
122
123struct workspace_manager {
124 struct list_head idle_ws;
125 spinlock_t ws_lock;
126 /* Number of free workspaces */
127 int free_ws;
128 /* Total number of allocated workspaces */
129 atomic_t total_ws;
130 /* Waiters for a free workspace */
131 wait_queue_head_t ws_wait;
132};
133
134struct list_head *btrfs_get_workspace(int type, unsigned int level);
135void btrfs_put_workspace(int type, struct list_head *ws);
136
137struct btrfs_compress_op {
138 struct workspace_manager *workspace_manager;
139 /* Maximum level supported by the compression algorithm */
140 unsigned int max_level;
141 unsigned int default_level;
142};
143
144/* The heuristic workspaces are managed via the 0th workspace manager */
145#define BTRFS_NR_WORKSPACE_MANAGERS BTRFS_NR_COMPRESS_TYPES
146
147extern const struct btrfs_compress_op btrfs_heuristic_compress;
148extern const struct btrfs_compress_op btrfs_zlib_compress;
149extern const struct btrfs_compress_op btrfs_lzo_compress;
150extern const struct btrfs_compress_op btrfs_zstd_compress;
151
152const char* btrfs_compress_type2str(enum btrfs_compression_type type);
153bool btrfs_compress_is_valid_type(const char *str, size_t len);
154
155int btrfs_compress_heuristic(struct btrfs_inode *inode, u64 start, u64 end);
156
157int btrfs_compress_filemap_get_folio(struct address_space *mapping, u64 start,
158 struct folio **in_folio_ret);
159
160int zlib_compress_folios(struct list_head *ws, struct address_space *mapping,
161 u64 start, struct folio **folios, unsigned long *out_folios,
162 unsigned long *total_in, unsigned long *total_out);
163int zlib_decompress_bio(struct list_head *ws, struct compressed_bio *cb);
164int zlib_decompress(struct list_head *ws, const u8 *data_in,
165 struct folio *dest_folio, unsigned long dest_pgoff, size_t srclen,
166 size_t destlen);
167struct list_head *zlib_alloc_workspace(unsigned int level);
168void zlib_free_workspace(struct list_head *ws);
169struct list_head *zlib_get_workspace(unsigned int level);
170
171int lzo_compress_folios(struct list_head *ws, struct address_space *mapping,
172 u64 start, struct folio **folios, unsigned long *out_folios,
173 unsigned long *total_in, unsigned long *total_out);
174int lzo_decompress_bio(struct list_head *ws, struct compressed_bio *cb);
175int lzo_decompress(struct list_head *ws, const u8 *data_in,
176 struct folio *dest_folio, unsigned long dest_pgoff, size_t srclen,
177 size_t destlen);
178struct list_head *lzo_alloc_workspace(void);
179void lzo_free_workspace(struct list_head *ws);
180
181int zstd_compress_folios(struct list_head *ws, struct address_space *mapping,
182 u64 start, struct folio **folios, unsigned long *out_folios,
183 unsigned long *total_in, unsigned long *total_out);
184int zstd_decompress_bio(struct list_head *ws, struct compressed_bio *cb);
185int zstd_decompress(struct list_head *ws, const u8 *data_in,
186 struct folio *dest_folio, unsigned long dest_pgoff, size_t srclen,
187 size_t destlen);
188void zstd_init_workspace_manager(void);
189void zstd_cleanup_workspace_manager(void);
190struct list_head *zstd_alloc_workspace(unsigned int level);
191void zstd_free_workspace(struct list_head *ws);
192struct list_head *zstd_get_workspace(unsigned int level);
193void zstd_put_workspace(struct list_head *ws);
194
195#endif