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
15 #define KMSG_COMPONENT "zram"
16 #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
18 #include <linux/module.h>
19 #include <linux/kernel.h>
20 #include <linux/bio.h>
21 #include <linux/bitops.h>
22 #include <linux/blkdev.h>
23 #include <linux/buffer_head.h>
24 #include <linux/device.h>
25 #include <linux/genhd.h>
26 #include <linux/highmem.h>
27 #include <linux/slab.h>
28 #include <linux/lzo.h>
29 #include <linux/string.h>
30 #include <linux/vmalloc.h>
35 static int zram_major;
36 static struct zram *devices;
38 /* Module params (documentation at end) */
39 static unsigned int num_devices;
41 static int zram_test_flag(struct zram *zram, u32 index,
42 enum zram_pageflags flag)
44 return zram->table[index].flags & BIT(flag);
47 static void zram_set_flag(struct zram *zram, u32 index,
48 enum zram_pageflags flag)
50 zram->table[index].flags |= BIT(flag);
53 static void zram_clear_flag(struct zram *zram, u32 index,
54 enum zram_pageflags flag)
56 zram->table[index].flags &= ~BIT(flag);
59 static int page_zero_filled(void *ptr)
64 page = (unsigned long *)ptr;
66 for (pos = 0; pos != PAGE_SIZE / sizeof(*page); pos++) {
74 static void zram_set_disksize(struct zram *zram, size_t totalram_bytes)
76 if (!zram->disksize) {
78 "disk size not provided. You can use disksize_kb module "
79 "param to specify size.\nUsing default: (%u%% of RAM).\n",
80 default_disksize_perc_ram
82 zram->disksize = default_disksize_perc_ram *
83 (totalram_bytes / 100);
86 if (zram->disksize > 2 * (totalram_bytes)) {
88 "There is little point creating a zram of greater than "
89 "twice the size of memory since we expect a 2:1 compression "
90 "ratio. Note that zram uses about 0.1%% of the size of "
91 "the disk when not in use so a huge zram is "
93 "\tMemory Size: %zu kB\n"
94 "\tSize you selected: %zu kB\n"
95 "Continuing anyway ...\n",
96 totalram_bytes >> 10, zram->disksize
100 zram->disksize &= PAGE_MASK;
103 static void zram_ioctl_get_stats(struct zram *zram,
104 struct zram_ioctl_stats *s)
106 s->disksize = zram->disksize;
108 #if defined(CONFIG_ZRAM_STATS)
110 struct zram_stats *rs = &zram->stats;
111 size_t succ_writes, mem_used;
112 unsigned int good_compress_perc = 0, no_compress_perc = 0;
114 mem_used = xv_get_total_size_bytes(zram->mem_pool)
115 + (rs->pages_expand << PAGE_SHIFT);
116 succ_writes = zram_stat64_read(zram, &rs->num_writes) -
117 zram_stat64_read(zram, &rs->failed_writes);
119 if (succ_writes && rs->pages_stored) {
120 good_compress_perc = rs->good_compress * 100
122 no_compress_perc = rs->pages_expand * 100
126 s->num_reads = zram_stat64_read(zram, &rs->num_reads);
127 s->num_writes = zram_stat64_read(zram, &rs->num_writes);
128 s->failed_reads = zram_stat64_read(zram, &rs->failed_reads);
129 s->failed_writes = zram_stat64_read(zram, &rs->failed_writes);
130 s->invalid_io = zram_stat64_read(zram, &rs->invalid_io);
131 s->notify_free = zram_stat64_read(zram, &rs->notify_free);
132 s->pages_zero = rs->pages_zero;
134 s->good_compress_pct = good_compress_perc;
135 s->pages_expand_pct = no_compress_perc;
137 s->pages_stored = rs->pages_stored;
138 s->pages_used = mem_used >> PAGE_SHIFT;
139 s->orig_data_size = rs->pages_stored << PAGE_SHIFT;
140 s->compr_data_size = rs->compr_size;
141 s->mem_used_total = mem_used;
143 #endif /* CONFIG_ZRAM_STATS */
146 static void zram_free_page(struct zram *zram, size_t index)
151 struct page *page = zram->table[index].page;
152 u32 offset = zram->table[index].offset;
154 if (unlikely(!page)) {
156 * No memory is allocated for zero filled pages.
157 * Simply clear zero page flag.
159 if (zram_test_flag(zram, index, ZRAM_ZERO)) {
160 zram_clear_flag(zram, index, ZRAM_ZERO);
161 zram_stat_dec(&zram->stats.pages_zero);
166 if (unlikely(zram_test_flag(zram, index, ZRAM_UNCOMPRESSED))) {
169 zram_clear_flag(zram, index, ZRAM_UNCOMPRESSED);
170 zram_stat_dec(&zram->stats.pages_expand);
174 obj = kmap_atomic(page, KM_USER0) + offset;
175 clen = xv_get_object_size(obj) - sizeof(struct zobj_header);
176 kunmap_atomic(obj, KM_USER0);
178 xv_free(zram->mem_pool, page, offset);
179 if (clen <= PAGE_SIZE / 2)
180 zram_stat_dec(&zram->stats.good_compress);
183 zram->stats.compr_size -= clen;
184 zram_stat_dec(&zram->stats.pages_stored);
186 zram->table[index].page = NULL;
187 zram->table[index].offset = 0;
190 static void handle_zero_page(struct page *page)
194 user_mem = kmap_atomic(page, KM_USER0);
195 memset(user_mem, 0, PAGE_SIZE);
196 kunmap_atomic(user_mem, KM_USER0);
198 flush_dcache_page(page);
201 static void handle_uncompressed_page(struct zram *zram,
202 struct page *page, u32 index)
204 unsigned char *user_mem, *cmem;
206 user_mem = kmap_atomic(page, KM_USER0);
207 cmem = kmap_atomic(zram->table[index].page, KM_USER1) +
208 zram->table[index].offset;
210 memcpy(user_mem, cmem, PAGE_SIZE);
211 kunmap_atomic(user_mem, KM_USER0);
212 kunmap_atomic(cmem, KM_USER1);
214 flush_dcache_page(page);
217 static int zram_read(struct zram *zram, struct bio *bio)
222 struct bio_vec *bvec;
224 zram_stat64_inc(zram, &zram->stats.num_reads);
226 index = bio->bi_sector >> SECTORS_PER_PAGE_SHIFT;
227 bio_for_each_segment(bvec, bio, i) {
231 struct zobj_header *zheader;
232 unsigned char *user_mem, *cmem;
234 page = bvec->bv_page;
236 if (zram_test_flag(zram, index, ZRAM_ZERO)) {
237 handle_zero_page(page);
242 /* Requested page is not present in compressed area */
243 if (unlikely(!zram->table[index].page)) {
244 pr_debug("Read before write: sector=%lu, size=%u",
245 (ulong)(bio->bi_sector), bio->bi_size);
251 /* Page is stored uncompressed since it's incompressible */
252 if (unlikely(zram_test_flag(zram, index, ZRAM_UNCOMPRESSED))) {
253 handle_uncompressed_page(zram, page, index);
258 user_mem = kmap_atomic(page, KM_USER0);
261 cmem = kmap_atomic(zram->table[index].page, KM_USER1) +
262 zram->table[index].offset;
264 ret = lzo1x_decompress_safe(
265 cmem + sizeof(*zheader),
266 xv_get_object_size(cmem) - sizeof(*zheader),
269 kunmap_atomic(user_mem, KM_USER0);
270 kunmap_atomic(cmem, KM_USER1);
272 /* Should NEVER happen. Return bio error if it does. */
273 if (unlikely(ret != LZO_E_OK)) {
274 pr_err("Decompression failed! err=%d, page=%u\n",
276 zram_stat64_inc(zram, &zram->stats.failed_reads);
280 flush_dcache_page(page);
284 set_bit(BIO_UPTODATE, &bio->bi_flags);
293 static int zram_write(struct zram *zram, struct bio *bio)
297 struct bio_vec *bvec;
299 zram_stat64_inc(zram, &zram->stats.num_writes);
301 index = bio->bi_sector >> SECTORS_PER_PAGE_SHIFT;
303 bio_for_each_segment(bvec, bio, i) {
307 struct zobj_header *zheader;
308 struct page *page, *page_store;
309 unsigned char *user_mem, *cmem, *src;
311 page = bvec->bv_page;
312 src = zram->compress_buffer;
315 * System overwrites unused sectors. Free memory associated
316 * with this sector now.
318 if (zram->table[index].page ||
319 zram_test_flag(zram, index, ZRAM_ZERO))
320 zram_free_page(zram, index);
322 mutex_lock(&zram->lock);
324 user_mem = kmap_atomic(page, KM_USER0);
325 if (page_zero_filled(user_mem)) {
326 kunmap_atomic(user_mem, KM_USER0);
327 mutex_unlock(&zram->lock);
328 zram_stat_inc(&zram->stats.pages_zero);
329 zram_set_flag(zram, index, ZRAM_ZERO);
334 ret = lzo1x_1_compress(user_mem, PAGE_SIZE, src, &clen,
335 zram->compress_workmem);
337 kunmap_atomic(user_mem, KM_USER0);
339 if (unlikely(ret != LZO_E_OK)) {
340 mutex_unlock(&zram->lock);
341 pr_err("Compression failed! err=%d\n", ret);
342 zram_stat64_inc(zram, &zram->stats.failed_writes);
347 * Page is incompressible. Store it as-is (uncompressed)
348 * since we do not want to return too many disk write
349 * errors which has side effect of hanging the system.
351 if (unlikely(clen > max_zpage_size)) {
353 page_store = alloc_page(GFP_NOIO | __GFP_HIGHMEM);
354 if (unlikely(!page_store)) {
355 mutex_unlock(&zram->lock);
356 pr_info("Error allocating memory for "
357 "incompressible page: %u\n", index);
358 zram_stat64_inc(zram,
359 &zram->stats.failed_writes);
364 zram_set_flag(zram, index, ZRAM_UNCOMPRESSED);
365 zram_stat_inc(&zram->stats.pages_expand);
366 zram->table[index].page = page_store;
367 src = kmap_atomic(page, KM_USER0);
371 if (xv_malloc(zram->mem_pool, clen + sizeof(*zheader),
372 &zram->table[index].page, &offset,
373 GFP_NOIO | __GFP_HIGHMEM)) {
374 mutex_unlock(&zram->lock);
375 pr_info("Error allocating memory for compressed "
376 "page: %u, size=%zu\n", index, clen);
377 zram_stat64_inc(zram, &zram->stats.failed_writes);
382 zram->table[index].offset = offset;
384 cmem = kmap_atomic(zram->table[index].page, KM_USER1) +
385 zram->table[index].offset;
388 /* Back-reference needed for memory defragmentation */
389 if (!zram_test_flag(zram, index, ZRAM_UNCOMPRESSED)) {
390 zheader = (struct zobj_header *)cmem;
391 zheader->table_idx = index;
392 cmem += sizeof(*zheader);
396 memcpy(cmem, src, clen);
398 kunmap_atomic(cmem, KM_USER1);
399 if (unlikely(zram_test_flag(zram, index, ZRAM_UNCOMPRESSED)))
400 kunmap_atomic(src, KM_USER0);
403 zram->stats.compr_size += clen;
404 zram_stat_inc(&zram->stats.pages_stored);
405 if (clen <= PAGE_SIZE / 2)
406 zram_stat_inc(&zram->stats.good_compress);
408 mutex_unlock(&zram->lock);
412 set_bit(BIO_UPTODATE, &bio->bi_flags);
422 * Check if request is within bounds and page aligned.
424 static inline int valid_io_request(struct zram *zram, struct bio *bio)
427 (bio->bi_sector >= (zram->disksize >> SECTOR_SHIFT)) ||
428 (bio->bi_sector & (SECTORS_PER_PAGE - 1)) ||
429 (bio->bi_size & (PAGE_SIZE - 1)))) {
434 /* I/O request is valid */
439 * Handler function for all zram I/O requests.
441 static int zram_make_request(struct request_queue *queue, struct bio *bio)
444 struct zram *zram = queue->queuedata;
446 if (unlikely(!zram->init_done)) {
451 if (!valid_io_request(zram, bio)) {
452 zram_stat64_inc(zram, &zram->stats.invalid_io);
457 switch (bio_data_dir(bio)) {
459 ret = zram_read(zram, bio);
463 ret = zram_write(zram, bio);
470 static void reset_device(struct zram *zram)
474 /* Do not accept any new I/O request */
477 /* Free various per-device buffers */
478 kfree(zram->compress_workmem);
479 free_pages((unsigned long)zram->compress_buffer, 1);
481 zram->compress_workmem = NULL;
482 zram->compress_buffer = NULL;
484 /* Free all pages that are still in this zram device */
485 for (index = 0; index < zram->disksize >> PAGE_SHIFT; index++) {
489 page = zram->table[index].page;
490 offset = zram->table[index].offset;
495 if (unlikely(zram_test_flag(zram, index, ZRAM_UNCOMPRESSED)))
498 xv_free(zram->mem_pool, page, offset);
504 xv_destroy_pool(zram->mem_pool);
505 zram->mem_pool = NULL;
508 memset(&zram->stats, 0, sizeof(zram->stats));
513 static int zram_ioctl_init_device(struct zram *zram)
518 if (zram->init_done) {
519 pr_info("Device already initialized!\n");
523 zram_set_disksize(zram, totalram_pages << PAGE_SHIFT);
525 zram->compress_workmem = kzalloc(LZO1X_MEM_COMPRESS, GFP_KERNEL);
526 if (!zram->compress_workmem) {
527 pr_err("Error allocating compressor working memory!\n");
532 zram->compress_buffer = (void *)__get_free_pages(__GFP_ZERO, 1);
533 if (!zram->compress_buffer) {
534 pr_err("Error allocating compressor buffer space\n");
539 num_pages = zram->disksize >> PAGE_SHIFT;
540 zram->table = vmalloc(num_pages * sizeof(*zram->table));
542 pr_err("Error allocating zram address table\n");
543 /* To prevent accessing table entries during cleanup */
548 memset(zram->table, 0, num_pages * sizeof(*zram->table));
550 set_capacity(zram->disk, zram->disksize >> SECTOR_SHIFT);
552 /* zram devices sort of resembles non-rotational disks */
553 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, zram->disk->queue);
555 zram->mem_pool = xv_create_pool();
556 if (!zram->mem_pool) {
557 pr_err("Error creating memory pool\n");
564 pr_debug("Initialization done!\n");
570 pr_err("Initialization failed: err=%d\n", ret);
574 static int zram_ioctl_reset_device(struct zram *zram)
582 static int zram_ioctl(struct block_device *bdev, fmode_t mode,
583 unsigned int cmd, unsigned long arg)
588 struct zram *zram = bdev->bd_disk->private_data;
591 case ZRAMIO_SET_DISKSIZE_KB:
592 if (zram->init_done) {
596 if (copy_from_user(&disksize_kb, (void *)arg,
601 zram->disksize = disksize_kb << 10;
602 pr_info("Disk size set to %zu kB\n", disksize_kb);
605 case ZRAMIO_GET_STATS:
607 struct zram_ioctl_stats *stats;
608 if (!zram->init_done) {
612 stats = kzalloc(sizeof(*stats), GFP_KERNEL);
617 zram_ioctl_get_stats(zram, stats);
618 if (copy_to_user((void *)arg, stats, sizeof(*stats))) {
627 ret = zram_ioctl_init_device(zram);
631 /* Do not reset an active device! */
632 if (bdev->bd_holders) {
637 /* Make sure all pending I/O is finished */
641 ret = zram_ioctl_reset_device(zram);
645 pr_info("Invalid ioctl %u\n", cmd);
653 void zram_slot_free_notify(struct block_device *bdev, unsigned long index)
657 zram = bdev->bd_disk->private_data;
658 zram_free_page(zram, index);
659 zram_stat64_inc(zram, &zram->stats.notify_free);
662 static const struct block_device_operations zram_devops = {
664 .swap_slot_free_notify = zram_slot_free_notify,
668 static int create_device(struct zram *zram, int device_id)
672 mutex_init(&zram->lock);
673 spin_lock_init(&zram->stat64_lock);
675 zram->queue = blk_alloc_queue(GFP_KERNEL);
677 pr_err("Error allocating disk queue for device %d\n",
683 blk_queue_make_request(zram->queue, zram_make_request);
684 zram->queue->queuedata = zram;
686 /* gendisk structure */
687 zram->disk = alloc_disk(1);
689 blk_cleanup_queue(zram->queue);
690 pr_warning("Error allocating disk structure for device %d\n",
696 zram->disk->major = zram_major;
697 zram->disk->first_minor = device_id;
698 zram->disk->fops = &zram_devops;
699 zram->disk->queue = zram->queue;
700 zram->disk->private_data = zram;
701 snprintf(zram->disk->disk_name, 16, "zram%d", device_id);
703 /* Actual capacity set using ZRAMIO_SET_DISKSIZE_KB ioctl */
704 set_capacity(zram->disk, 0);
707 * To ensure that we always get PAGE_SIZE aligned
708 * and n*PAGE_SIZED sized I/O requests.
710 blk_queue_physical_block_size(zram->disk->queue, PAGE_SIZE);
711 blk_queue_logical_block_size(zram->disk->queue, PAGE_SIZE);
712 blk_queue_io_min(zram->disk->queue, PAGE_SIZE);
713 blk_queue_io_opt(zram->disk->queue, PAGE_SIZE);
715 add_disk(zram->disk);
723 static void destroy_device(struct zram *zram)
726 del_gendisk(zram->disk);
727 put_disk(zram->disk);
731 blk_cleanup_queue(zram->queue);
734 static int __init zram_init(void)
738 if (num_devices > max_num_devices) {
739 pr_warning("Invalid value for num_devices: %u\n",
745 zram_major = register_blkdev(0, "zram");
746 if (zram_major <= 0) {
747 pr_warning("Unable to get major number\n");
753 pr_info("num_devices not specified. Using default: 1\n");
757 /* Allocate the device array and initialize each one */
758 pr_info("Creating %u devices ...\n", num_devices);
759 devices = kzalloc(num_devices * sizeof(struct zram), GFP_KERNEL);
765 for (dev_id = 0; dev_id < num_devices; dev_id++) {
766 ret = create_device(&devices[dev_id], dev_id);
775 destroy_device(&devices[--dev_id]);
778 unregister_blkdev(zram_major, "zram");
783 static void __exit zram_exit(void)
788 for (i = 0; i < num_devices; i++) {
791 destroy_device(zram);
796 unregister_blkdev(zram_major, "zram");
799 pr_debug("Cleanup done!\n");
802 module_param(num_devices, uint, 0);
803 MODULE_PARM_DESC(num_devices, "Number of zram devices");
805 module_init(zram_init);
806 module_exit(zram_exit);
808 MODULE_LICENSE("Dual BSD/GPL");
809 MODULE_AUTHOR("Nitin Gupta <ngupta@vflare.org>");
810 MODULE_DESCRIPTION("Compressed RAM Block Device");