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/bitops.h>
21 #include <linux/blkdev.h>
22 #include <linux/buffer_head.h>
23 #include <linux/device.h>
24 #include <linux/genhd.h>
25 #include <linux/highmem.h>
26 #include <linux/slab.h>
27 #include <linux/lzo.h>
28 #include <linux/string.h>
29 #include <linux/vmalloc.h>
34 static int zram_major;
35 static struct zram *devices;
37 /* Module params (documentation at end) */
38 static unsigned int num_devices;
40 static int zram_test_flag(struct zram *zram, u32 index,
41 enum zram_pageflags flag)
43 return zram->table[index].flags & BIT(flag);
46 static void zram_set_flag(struct zram *zram, u32 index,
47 enum zram_pageflags flag)
49 zram->table[index].flags |= BIT(flag);
52 static void zram_clear_flag(struct zram *zram, u32 index,
53 enum zram_pageflags flag)
55 zram->table[index].flags &= ~BIT(flag);
58 static int page_zero_filled(void *ptr)
63 page = (unsigned long *)ptr;
65 for (pos = 0; pos != PAGE_SIZE / sizeof(*page); pos++) {
73 static void zram_set_disksize(struct zram *zram, size_t totalram_bytes)
75 if (!zram->disksize) {
77 "disk size not provided. You can use disksize_kb module "
78 "param to specify size.\nUsing default: (%u%% of RAM).\n",
79 default_disksize_perc_ram
81 zram->disksize = default_disksize_perc_ram *
82 (totalram_bytes / 100);
85 if (zram->disksize > 2 * (totalram_bytes)) {
87 "There is little point creating a zram of greater than "
88 "twice the size of memory since we expect a 2:1 compression "
89 "ratio. Note that zram uses about 0.1%% of the size of "
90 "the disk when not in use so a huge zram is "
92 "\tMemory Size: %zu kB\n"
93 "\tSize you selected: %zu kB\n"
94 "Continuing anyway ...\n",
95 totalram_bytes >> 10, zram->disksize
99 zram->disksize &= PAGE_MASK;
102 static void zram_ioctl_get_stats(struct zram *zram,
103 struct zram_ioctl_stats *s)
105 s->disksize = zram->disksize;
107 #if defined(CONFIG_ZRAM_STATS)
109 struct zram_stats *rs = &zram->stats;
110 size_t succ_writes, mem_used;
111 unsigned int good_compress_perc = 0, no_compress_perc = 0;
113 mem_used = xv_get_total_size_bytes(zram->mem_pool)
114 + (rs->pages_expand << PAGE_SHIFT);
115 succ_writes = zram_stat64_read(zram, &rs->num_writes) -
116 zram_stat64_read(zram, &rs->failed_writes);
118 if (succ_writes && rs->pages_stored) {
119 good_compress_perc = rs->good_compress * 100
121 no_compress_perc = rs->pages_expand * 100
125 s->num_reads = zram_stat64_read(zram, &rs->num_reads);
126 s->num_writes = zram_stat64_read(zram, &rs->num_writes);
127 s->failed_reads = zram_stat64_read(zram, &rs->failed_reads);
128 s->failed_writes = zram_stat64_read(zram, &rs->failed_writes);
129 s->invalid_io = zram_stat64_read(zram, &rs->invalid_io);
130 s->notify_free = zram_stat64_read(zram, &rs->notify_free);
131 s->pages_zero = rs->pages_zero;
133 s->good_compress_pct = good_compress_perc;
134 s->pages_expand_pct = no_compress_perc;
136 s->pages_stored = rs->pages_stored;
137 s->pages_used = mem_used >> PAGE_SHIFT;
138 s->orig_data_size = rs->pages_stored << PAGE_SHIFT;
139 s->compr_data_size = rs->compr_size;
140 s->mem_used_total = mem_used;
142 #endif /* CONFIG_ZRAM_STATS */
145 static void zram_free_page(struct zram *zram, size_t index)
150 struct page *page = zram->table[index].page;
151 u32 offset = zram->table[index].offset;
153 if (unlikely(!page)) {
155 * No memory is allocated for zero filled pages.
156 * Simply clear zero page flag.
158 if (zram_test_flag(zram, index, ZRAM_ZERO)) {
159 zram_clear_flag(zram, index, ZRAM_ZERO);
160 zram_stat_dec(&zram->stats.pages_zero);
165 if (unlikely(zram_test_flag(zram, index, ZRAM_UNCOMPRESSED))) {
168 zram_clear_flag(zram, index, ZRAM_UNCOMPRESSED);
169 zram_stat_dec(&zram->stats.pages_expand);
173 obj = kmap_atomic(page, KM_USER0) + offset;
174 clen = xv_get_object_size(obj) - sizeof(struct zobj_header);
175 kunmap_atomic(obj, KM_USER0);
177 xv_free(zram->mem_pool, page, offset);
178 if (clen <= PAGE_SIZE / 2)
179 zram_stat_dec(&zram->stats.good_compress);
182 zram->stats.compr_size -= clen;
183 zram_stat_dec(&zram->stats.pages_stored);
185 zram->table[index].page = NULL;
186 zram->table[index].offset = 0;
189 static void handle_zero_page(struct page *page)
193 user_mem = kmap_atomic(page, KM_USER0);
194 memset(user_mem, 0, PAGE_SIZE);
195 kunmap_atomic(user_mem, KM_USER0);
197 flush_dcache_page(page);
200 static void handle_uncompressed_page(struct zram *zram,
201 struct page *page, u32 index)
203 unsigned char *user_mem, *cmem;
205 user_mem = kmap_atomic(page, KM_USER0);
206 cmem = kmap_atomic(zram->table[index].page, KM_USER1) +
207 zram->table[index].offset;
209 memcpy(user_mem, cmem, PAGE_SIZE);
210 kunmap_atomic(user_mem, KM_USER0);
211 kunmap_atomic(cmem, KM_USER1);
213 flush_dcache_page(page);
216 static int zram_read(struct zram *zram, struct bio *bio)
221 struct bio_vec *bvec;
223 zram_stat64_inc(zram, &zram->stats.num_reads);
225 index = bio->bi_sector >> SECTORS_PER_PAGE_SHIFT;
226 bio_for_each_segment(bvec, bio, i) {
230 struct zobj_header *zheader;
231 unsigned char *user_mem, *cmem;
233 page = bvec->bv_page;
235 if (zram_test_flag(zram, index, ZRAM_ZERO)) {
236 handle_zero_page(page);
240 /* Requested page is not present in compressed area */
241 if (unlikely(!zram->table[index].page)) {
242 pr_debug("Read before write: sector=%lu, size=%u",
243 (ulong)(bio->bi_sector), bio->bi_size);
248 /* Page is stored uncompressed since it's incompressible */
249 if (unlikely(zram_test_flag(zram, index, ZRAM_UNCOMPRESSED))) {
250 handle_uncompressed_page(zram, page, index);
254 user_mem = kmap_atomic(page, KM_USER0);
257 cmem = kmap_atomic(zram->table[index].page, KM_USER1) +
258 zram->table[index].offset;
260 ret = lzo1x_decompress_safe(
261 cmem + sizeof(*zheader),
262 xv_get_object_size(cmem) - sizeof(*zheader),
265 kunmap_atomic(user_mem, KM_USER0);
266 kunmap_atomic(cmem, KM_USER1);
268 /* Should NEVER happen. Return bio error if it does. */
269 if (unlikely(ret != LZO_E_OK)) {
270 pr_err("Decompression failed! err=%d, page=%u\n",
272 zram_stat64_inc(zram, &zram->stats.failed_reads);
276 flush_dcache_page(page);
280 set_bit(BIO_UPTODATE, &bio->bi_flags);
289 static int zram_write(struct zram *zram, struct bio *bio)
293 struct bio_vec *bvec;
295 zram_stat64_inc(zram, &zram->stats.num_writes);
297 index = bio->bi_sector >> SECTORS_PER_PAGE_SHIFT;
299 bio_for_each_segment(bvec, bio, i) {
303 struct zobj_header *zheader;
304 struct page *page, *page_store;
305 unsigned char *user_mem, *cmem, *src;
307 page = bvec->bv_page;
308 src = zram->compress_buffer;
311 * System overwrites unused sectors. Free memory associated
312 * with this sector now.
314 if (zram->table[index].page ||
315 zram_test_flag(zram, index, ZRAM_ZERO))
316 zram_free_page(zram, index);
318 mutex_lock(&zram->lock);
320 user_mem = kmap_atomic(page, KM_USER0);
321 if (page_zero_filled(user_mem)) {
322 kunmap_atomic(user_mem, KM_USER0);
323 mutex_unlock(&zram->lock);
324 zram_stat_inc(&zram->stats.pages_zero);
325 zram_set_flag(zram, index, ZRAM_ZERO);
329 ret = lzo1x_1_compress(user_mem, PAGE_SIZE, src, &clen,
330 zram->compress_workmem);
332 kunmap_atomic(user_mem, KM_USER0);
334 if (unlikely(ret != LZO_E_OK)) {
335 mutex_unlock(&zram->lock);
336 pr_err("Compression failed! err=%d\n", ret);
337 zram_stat64_inc(zram, &zram->stats.failed_writes);
342 * Page is incompressible. Store it as-is (uncompressed)
343 * since we do not want to return too many disk write
344 * errors which has side effect of hanging the system.
346 if (unlikely(clen > max_zpage_size)) {
348 page_store = alloc_page(GFP_NOIO | __GFP_HIGHMEM);
349 if (unlikely(!page_store)) {
350 mutex_unlock(&zram->lock);
351 pr_info("Error allocating memory for "
352 "incompressible page: %u\n", index);
353 zram_stat64_inc(zram,
354 &zram->stats.failed_writes);
359 zram_set_flag(zram, index, ZRAM_UNCOMPRESSED);
360 zram_stat_inc(&zram->stats.pages_expand);
361 zram->table[index].page = page_store;
362 src = kmap_atomic(page, KM_USER0);
366 if (xv_malloc(zram->mem_pool, clen + sizeof(*zheader),
367 &zram->table[index].page, &offset,
368 GFP_NOIO | __GFP_HIGHMEM)) {
369 mutex_unlock(&zram->lock);
370 pr_info("Error allocating memory for compressed "
371 "page: %u, size=%zu\n", index, clen);
372 zram_stat64_inc(zram, &zram->stats.failed_writes);
377 zram->table[index].offset = offset;
379 cmem = kmap_atomic(zram->table[index].page, KM_USER1) +
380 zram->table[index].offset;
383 /* Back-reference needed for memory defragmentation */
384 if (!zram_test_flag(zram, index, ZRAM_UNCOMPRESSED)) {
385 zheader = (struct zobj_header *)cmem;
386 zheader->table_idx = index;
387 cmem += sizeof(*zheader);
391 memcpy(cmem, src, clen);
393 kunmap_atomic(cmem, KM_USER1);
394 if (unlikely(zram_test_flag(zram, index, ZRAM_UNCOMPRESSED)))
395 kunmap_atomic(src, KM_USER0);
398 zram->stats.compr_size += clen;
399 zram_stat_inc(&zram->stats.pages_stored);
400 if (clen <= PAGE_SIZE / 2)
401 zram_stat_inc(&zram->stats.good_compress);
403 mutex_unlock(&zram->lock);
407 set_bit(BIO_UPTODATE, &bio->bi_flags);
417 * Check if request is within bounds and page aligned.
419 static inline int valid_io_request(struct zram *zram, struct bio *bio)
422 (bio->bi_sector >= (zram->disksize >> SECTOR_SHIFT)) ||
423 (bio->bi_sector & (SECTORS_PER_PAGE - 1)) ||
424 (bio->bi_size & (PAGE_SIZE - 1)))) {
429 /* I/O request is valid */
434 * Handler function for all zram I/O requests.
436 static int zram_make_request(struct request_queue *queue, struct bio *bio)
439 struct zram *zram = queue->queuedata;
441 if (unlikely(!zram->init_done)) {
446 if (!valid_io_request(zram, bio)) {
447 zram_stat64_inc(zram, &zram->stats.invalid_io);
452 switch (bio_data_dir(bio)) {
454 ret = zram_read(zram, bio);
458 ret = zram_write(zram, bio);
465 static void reset_device(struct zram *zram)
469 /* Do not accept any new I/O request */
472 /* Free various per-device buffers */
473 kfree(zram->compress_workmem);
474 free_pages((unsigned long)zram->compress_buffer, 1);
476 zram->compress_workmem = NULL;
477 zram->compress_buffer = NULL;
479 /* Free all pages that are still in this zram device */
480 for (index = 0; index < zram->disksize >> PAGE_SHIFT; index++) {
484 page = zram->table[index].page;
485 offset = zram->table[index].offset;
490 if (unlikely(zram_test_flag(zram, index, ZRAM_UNCOMPRESSED)))
493 xv_free(zram->mem_pool, page, offset);
499 xv_destroy_pool(zram->mem_pool);
500 zram->mem_pool = NULL;
503 memset(&zram->stats, 0, sizeof(zram->stats));
508 static int zram_ioctl_init_device(struct zram *zram)
513 if (zram->init_done) {
514 pr_info("Device already initialized!\n");
518 zram_set_disksize(zram, totalram_pages << PAGE_SHIFT);
520 zram->compress_workmem = kzalloc(LZO1X_MEM_COMPRESS, GFP_KERNEL);
521 if (!zram->compress_workmem) {
522 pr_err("Error allocating compressor working memory!\n");
527 zram->compress_buffer = (void *)__get_free_pages(__GFP_ZERO, 1);
528 if (!zram->compress_buffer) {
529 pr_err("Error allocating compressor buffer space\n");
534 num_pages = zram->disksize >> PAGE_SHIFT;
535 zram->table = vmalloc(num_pages * sizeof(*zram->table));
537 pr_err("Error allocating zram address table\n");
538 /* To prevent accessing table entries during cleanup */
543 memset(zram->table, 0, num_pages * sizeof(*zram->table));
545 set_capacity(zram->disk, zram->disksize >> SECTOR_SHIFT);
547 /* zram devices sort of resembles non-rotational disks */
548 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, zram->disk->queue);
550 zram->mem_pool = xv_create_pool();
551 if (!zram->mem_pool) {
552 pr_err("Error creating memory pool\n");
559 pr_debug("Initialization done!\n");
565 pr_err("Initialization failed: err=%d\n", ret);
569 static int zram_ioctl_reset_device(struct zram *zram)
577 static int zram_ioctl(struct block_device *bdev, fmode_t mode,
578 unsigned int cmd, unsigned long arg)
583 struct zram *zram = bdev->bd_disk->private_data;
586 case ZRAMIO_SET_DISKSIZE_KB:
587 if (zram->init_done) {
591 if (copy_from_user(&disksize_kb, (void *)arg,
596 zram->disksize = disksize_kb << 10;
597 pr_info("Disk size set to %zu kB\n", disksize_kb);
600 case ZRAMIO_GET_STATS:
602 struct zram_ioctl_stats *stats;
603 if (!zram->init_done) {
607 stats = kzalloc(sizeof(*stats), GFP_KERNEL);
612 zram_ioctl_get_stats(zram, stats);
613 if (copy_to_user((void *)arg, stats, sizeof(*stats))) {
622 ret = zram_ioctl_init_device(zram);
626 /* Do not reset an active device! */
627 if (bdev->bd_holders) {
632 /* Make sure all pending I/O is finished */
636 ret = zram_ioctl_reset_device(zram);
640 pr_info("Invalid ioctl %u\n", cmd);
648 void zram_slot_free_notify(struct block_device *bdev, unsigned long index)
652 zram = bdev->bd_disk->private_data;
653 zram_free_page(zram, index);
654 zram_stat64_inc(zram, &zram->stats.notify_free);
657 static const struct block_device_operations zram_devops = {
659 .swap_slot_free_notify = zram_slot_free_notify,
663 static int create_device(struct zram *zram, int device_id)
667 mutex_init(&zram->lock);
668 spin_lock_init(&zram->stat64_lock);
670 zram->queue = blk_alloc_queue(GFP_KERNEL);
672 pr_err("Error allocating disk queue for device %d\n",
678 blk_queue_make_request(zram->queue, zram_make_request);
679 zram->queue->queuedata = zram;
681 /* gendisk structure */
682 zram->disk = alloc_disk(1);
684 blk_cleanup_queue(zram->queue);
685 pr_warning("Error allocating disk structure for device %d\n",
691 zram->disk->major = zram_major;
692 zram->disk->first_minor = device_id;
693 zram->disk->fops = &zram_devops;
694 zram->disk->queue = zram->queue;
695 zram->disk->private_data = zram;
696 snprintf(zram->disk->disk_name, 16, "zram%d", device_id);
698 /* Actual capacity set using ZRAMIO_SET_DISKSIZE_KB ioctl */
699 set_capacity(zram->disk, 0);
702 * To ensure that we always get PAGE_SIZE aligned
703 * and n*PAGE_SIZED sized I/O requests.
705 blk_queue_physical_block_size(zram->disk->queue, PAGE_SIZE);
706 blk_queue_logical_block_size(zram->disk->queue, PAGE_SIZE);
707 blk_queue_io_min(zram->disk->queue, PAGE_SIZE);
708 blk_queue_io_opt(zram->disk->queue, PAGE_SIZE);
710 add_disk(zram->disk);
718 static void destroy_device(struct zram *zram)
721 del_gendisk(zram->disk);
722 put_disk(zram->disk);
726 blk_cleanup_queue(zram->queue);
729 static int __init zram_init(void)
733 if (num_devices > max_num_devices) {
734 pr_warning("Invalid value for num_devices: %u\n",
740 zram_major = register_blkdev(0, "zram");
741 if (zram_major <= 0) {
742 pr_warning("Unable to get major number\n");
748 pr_info("num_devices not specified. Using default: 1\n");
752 /* Allocate the device array and initialize each one */
753 pr_info("Creating %u devices ...\n", num_devices);
754 devices = kzalloc(num_devices * sizeof(struct zram), GFP_KERNEL);
760 for (dev_id = 0; dev_id < num_devices; dev_id++) {
761 ret = create_device(&devices[dev_id], dev_id);
770 destroy_device(&devices[--dev_id]);
772 unregister_blkdev(zram_major, "zram");
777 static void __exit zram_exit(void)
782 for (i = 0; i < num_devices; i++) {
785 destroy_device(zram);
790 unregister_blkdev(zram_major, "zram");
793 pr_debug("Cleanup done!\n");
796 module_param(num_devices, uint, 0);
797 MODULE_PARM_DESC(num_devices, "Number of zram devices");
799 module_init(zram_init);
800 module_exit(zram_exit);
802 MODULE_LICENSE("Dual BSD/GPL");
803 MODULE_AUTHOR("Nitin Gupta <ngupta@vflare.org>");
804 MODULE_DESCRIPTION("Compressed RAM Block Device");