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