2 * Compressed RAM block device
4 * Copyright (C) 2008, 2009, 2010 Nitin Gupta
6 * This code is released using a dual license strategy: BSD/GPL
7 * You can choose the licence that better fits your requirements.
9 * Released under the terms of 3-clause BSD License
10 * Released under the terms of GNU General Public License Version 2.0
12 * Project home: http://compcache.googlecode.com
18 #include <linux/spinlock.h>
19 #include <linux/mutex.h>
20 #include <linux/zsmalloc.h>
23 * Some arbitrary value. This is just to catch
24 * invalid value for num_devices module parameter.
26 static const unsigned max_num_devices = 32;
28 /*-- Configurable parameters */
31 * Pages that compress to size greater than this are stored
32 * uncompressed in memory.
34 static const size_t max_zpage_size = PAGE_SIZE / 4 * 3;
37 * NOTE: max_zpage_size must be less than or equal to:
38 * ZS_MAX_ALLOC_SIZE. Otherwise, zs_malloc() would
39 * always return failure.
42 /*-- End of configurable params */
44 #define SECTOR_SHIFT 9
45 #define SECTOR_SIZE (1 << SECTOR_SHIFT)
46 #define SECTORS_PER_PAGE_SHIFT (PAGE_SHIFT - SECTOR_SHIFT)
47 #define SECTORS_PER_PAGE (1 << SECTORS_PER_PAGE_SHIFT)
48 #define ZRAM_LOGICAL_BLOCK_SHIFT 12
49 #define ZRAM_LOGICAL_BLOCK_SIZE (1 << ZRAM_LOGICAL_BLOCK_SHIFT)
50 #define ZRAM_SECTOR_PER_LOGICAL_BLOCK \
51 (1 << (ZRAM_LOGICAL_BLOCK_SHIFT - SECTOR_SHIFT))
53 /* Flags for zram pages (table[page_no].flags) */
55 /* Page consists entirely of zeros */
61 /*-- Data structures */
63 /* Allocated for each disk page */
66 u16 size; /* object size (excluding header) */
67 u8 count; /* object ref count (not yet used) */
72 * All 64bit fields should only be manipulated by 64bit atomic accessors.
73 * All modifications to 32bit counter should be protected by zram->lock.
76 atomic64_t compr_size; /* compressed size of pages stored */
77 atomic64_t num_reads; /* failed + successful */
78 atomic64_t num_writes; /* --do-- */
79 atomic64_t failed_reads; /* should NEVER! happen */
80 atomic64_t failed_writes; /* can happen when memory is too low */
81 atomic64_t invalid_io; /* non-page-aligned I/O requests */
82 atomic64_t notify_free; /* no. of swap slot free notifications */
83 u32 pages_zero; /* no. of zero filled pages */
84 u32 pages_stored; /* no. of pages currently stored */
85 u32 good_compress; /* % of pages with compression ratio<=50% */
86 u32 bad_compress; /* % of pages with compression ratio>=75% */
90 void *compress_workmem;
91 void *compress_buffer;
93 struct zs_pool *mem_pool;
96 struct zram_slot_free {
98 struct zram_slot_free *next;
102 struct zram_meta *meta;
103 struct rw_semaphore lock; /* protect compression buffers, table,
104 * 32bit stat counters against concurrent
105 * notifications, reads and writes */
107 struct work_struct free_work; /* handle pending free request */
108 struct zram_slot_free *slot_free_rq; /* list head of free request */
110 struct request_queue *queue;
111 struct gendisk *disk;
113 /* Prevent concurrent execution of device init, reset and R/W request */
114 struct rw_semaphore init_lock;
116 * This is the limit on amount of *uncompressed* worth of data
117 * we can store in a disk.
119 u64 disksize; /* bytes */
120 spinlock_t slot_free_lock;
122 struct zram_stats stats;