[mirror_ubuntu-hirsute-kernel.git] / fs / btrfs / compression.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 2008 Oracle.  All rights reserved.
 */

#ifndef BTRFS_COMPRESSION_H
#define BTRFS_COMPRESSION_H

#include <linux/sizes.h>

struct btrfs_inode;

/*
 * We want to make sure that amount of RAM required to uncompress an extent is
 * reasonable, so we limit the total size in ram of a compressed extent to
 * 128k.  This is a crucial number because it also controls how easily we can
 * spread reads across cpus for decompression.
 *
 * We also want to make sure the amount of IO required to do a random read is
 * reasonably small, so we limit the size of a compressed extent to 128k.
 */

/* Maximum length of compressed data stored on disk */
#define BTRFS_MAX_COMPRESSED		(SZ_128K)
/* Maximum size of data before compression */
#define BTRFS_MAX_UNCOMPRESSED		(SZ_128K)

#define	BTRFS_ZLIB_DEFAULT_LEVEL		3

struct compressed_bio {
	/* number of bios pending for this compressed extent */
	refcount_t pending_bios;

	/* the pages with the compressed data on them */
	struct page **compressed_pages;

	/* inode that owns this data */
	struct inode *inode;

	/* starting offset in the inode for our pages */
	u64 start;

	/* number of bytes in the inode we're working on */
	unsigned long len;

	/* number of bytes on disk */
	unsigned long compressed_len;

	/* the compression algorithm for this bio */
	int compress_type;

	/* number of compressed pages in the array */
	unsigned long nr_pages;

	/* IO errors */
	int errors;
	int mirror_num;

	/* for reads, this is the bio we are copying the data into */
	struct bio *orig_bio;

	/*
	 * the start of a variable length array of checksums only
	 * used by reads
	 */
	u8 sums[];
};

static inline unsigned int btrfs_compress_type(unsigned int type_level)
{
	return (type_level & 0xF);
}

static inline unsigned int btrfs_compress_level(unsigned int type_level)
{
	return ((type_level & 0xF0) >> 4);
}

void __init btrfs_init_compress(void);
void __cold btrfs_exit_compress(void);

int btrfs_compress_pages(unsigned int type_level, struct address_space *mapping,
			 u64 start, struct page **pages,
			 unsigned long *out_pages,
			 unsigned long *total_in,
			 unsigned long *total_out);
int btrfs_decompress(int type, unsigned char *data_in, struct page *dest_page,
		     unsigned long start_byte, size_t srclen, size_t destlen);
int btrfs_decompress_buf2page(const char *buf, unsigned long buf_start,
			      unsigned long total_out, u64 disk_start,
			      struct bio *bio);

blk_status_t btrfs_submit_compressed_write(struct btrfs_inode *inode, u64 start,
				  unsigned long len, u64 disk_start,
				  unsigned long compressed_len,
				  struct page **compressed_pages,
				  unsigned long nr_pages,
				  unsigned int write_flags,
				  struct cgroup_subsys_state *blkcg_css);
blk_status_t btrfs_submit_compressed_read(struct inode *inode, struct bio *bio,
				 int mirror_num, unsigned long bio_flags);

unsigned int btrfs_compress_str2level(unsigned int type, const char *str);

enum btrfs_compression_type {
	BTRFS_COMPRESS_NONE  = 0,
	BTRFS_COMPRESS_ZLIB  = 1,
	BTRFS_COMPRESS_LZO   = 2,
	BTRFS_COMPRESS_ZSTD  = 3,
	BTRFS_NR_COMPRESS_TYPES = 4,
};

struct workspace_manager {
	struct list_head idle_ws;
	spinlock_t ws_lock;
	/* Number of free workspaces */
	int free_ws;
	/* Total number of allocated workspaces */
	atomic_t total_ws;
	/* Waiters for a free workspace */
	wait_queue_head_t ws_wait;
};

struct list_head *btrfs_get_workspace(int type, unsigned int level);
void btrfs_put_workspace(int type, struct list_head *ws);

struct btrfs_compress_op {
	struct workspace_manager *workspace_manager;
	/* Maximum level supported by the compression algorithm */
	unsigned int max_level;
	unsigned int default_level;
};

/* The heuristic workspaces are managed via the 0th workspace manager */
#define BTRFS_NR_WORKSPACE_MANAGERS	BTRFS_NR_COMPRESS_TYPES

extern const struct btrfs_compress_op btrfs_heuristic_compress;
extern const struct btrfs_compress_op btrfs_zlib_compress;
extern const struct btrfs_compress_op btrfs_lzo_compress;
extern const struct btrfs_compress_op btrfs_zstd_compress;

const char* btrfs_compress_type2str(enum btrfs_compression_type type);
bool btrfs_compress_is_valid_type(const char *str, size_t len);

int btrfs_compress_heuristic(struct inode *inode, u64 start, u64 end);

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