zram_drv.c 44.8 KB
Newer Older
1
/*
2
 * Compressed RAM block device
3
 *
4
 * Copyright (C) 2008, 2009, 2010  Nitin Gupta
M
Minchan Kim 已提交
5
 *               2012, 2013 Minchan Kim
6 7 8 9 10 11 12 13 14
 *
 * This code is released using a dual license strategy: BSD/GPL
 * You can choose the licence that better fits your requirements.
 *
 * Released under the terms of 3-clause BSD License
 * Released under the terms of GNU General Public License Version 2.0
 *
 */

15
#define KMSG_COMPONENT "zram"
16 17 18 19
#define pr_fmt(fmt) KMSG_COMPONENT ": " fmt

#include <linux/module.h>
#include <linux/kernel.h>
20
#include <linux/bio.h>
21 22 23 24 25 26
#include <linux/bitops.h>
#include <linux/blkdev.h>
#include <linux/buffer_head.h>
#include <linux/device.h>
#include <linux/genhd.h>
#include <linux/highmem.h>
27
#include <linux/slab.h>
28
#include <linux/backing-dev.h>
29 30
#include <linux/string.h>
#include <linux/vmalloc.h>
31
#include <linux/err.h>
32
#include <linux/idr.h>
33
#include <linux/sysfs.h>
34
#include <linux/debugfs.h>
35
#include <linux/cpuhotplug.h>
36

37
#include "zram_drv.h"
38

39
static DEFINE_IDR(zram_index_idr);
40 41 42
/* idr index must be protected */
static DEFINE_MUTEX(zram_index_mutex);

43
static int zram_major;
44
static const char *default_compressor = "lzo";
45 46

/* Module params (documentation at end) */
47
static unsigned int num_devices = 1;
48 49 50 51 52
/*
 * Pages that compress to sizes equals or greater than this are stored
 * uncompressed in memory.
 */
static size_t huge_class_size;
53

M
Minchan Kim 已提交
54 55
static void zram_free_page(struct zram *zram, size_t index);

56 57 58 59 60 61 62 63 64 65
static void zram_slot_lock(struct zram *zram, u32 index)
{
	bit_spin_lock(ZRAM_LOCK, &zram->table[index].value);
}

static void zram_slot_unlock(struct zram *zram, u32 index)
{
	bit_spin_unlock(ZRAM_LOCK, &zram->table[index].value);
}

66
static inline bool init_done(struct zram *zram)
67
{
68
	return zram->disksize;
69 70
}

71 72 73 74 75 76 77
static inline bool zram_allocated(struct zram *zram, u32 index)
{

	return (zram->table[index].value >> (ZRAM_FLAG_SHIFT + 1)) ||
					zram->table[index].handle;
}

78 79 80 81 82
static inline struct zram *dev_to_zram(struct device *dev)
{
	return (struct zram *)dev_to_disk(dev)->private_data;
}

M
Minchan Kim 已提交
83 84 85 86 87 88 89 90 91 92
static unsigned long zram_get_handle(struct zram *zram, u32 index)
{
	return zram->table[index].handle;
}

static void zram_set_handle(struct zram *zram, u32 index, unsigned long handle)
{
	zram->table[index].handle = handle;
}

93
/* flag operations require table entry bit_spin_lock() being held */
94
static bool zram_test_flag(struct zram *zram, u32 index,
95
			enum zram_pageflags flag)
96
{
M
Minchan Kim 已提交
97
	return zram->table[index].value & BIT(flag);
98
}
99

M
Minchan Kim 已提交
100
static void zram_set_flag(struct zram *zram, u32 index,
101 102
			enum zram_pageflags flag)
{
M
Minchan Kim 已提交
103
	zram->table[index].value |= BIT(flag);
104
}
105

M
Minchan Kim 已提交
106
static void zram_clear_flag(struct zram *zram, u32 index,
107 108
			enum zram_pageflags flag)
{
M
Minchan Kim 已提交
109
	zram->table[index].value &= ~BIT(flag);
110
}
111

M
Minchan Kim 已提交
112
static inline void zram_set_element(struct zram *zram, u32 index,
113 114
			unsigned long element)
{
M
Minchan Kim 已提交
115
	zram->table[index].element = element;
116 117
}

M
Minchan Kim 已提交
118
static unsigned long zram_get_element(struct zram *zram, u32 index)
119
{
M
Minchan Kim 已提交
120
	return zram->table[index].element;
121 122
}

M
Minchan Kim 已提交
123
static size_t zram_get_obj_size(struct zram *zram, u32 index)
124
{
M
Minchan Kim 已提交
125
	return zram->table[index].value & (BIT(ZRAM_FLAG_SHIFT) - 1);
126 127
}

M
Minchan Kim 已提交
128
static void zram_set_obj_size(struct zram *zram,
129
					u32 index, size_t size)
130
{
M
Minchan Kim 已提交
131
	unsigned long flags = zram->table[index].value >> ZRAM_FLAG_SHIFT;
132

M
Minchan Kim 已提交
133
	zram->table[index].value = (flags << ZRAM_FLAG_SHIFT) | size;
134 135
}

M
Minchan Kim 已提交
136
#if PAGE_SIZE != 4096
137
static inline bool is_partial_io(struct bio_vec *bvec)
138 139 140
{
	return bvec->bv_len != PAGE_SIZE;
}
M
Minchan Kim 已提交
141 142 143 144 145 146
#else
static inline bool is_partial_io(struct bio_vec *bvec)
{
	return false;
}
#endif
147 148 149 150

/*
 * Check if request is within bounds and aligned on zram logical blocks.
 */
151
static inline bool valid_io_request(struct zram *zram,
152 153 154 155 156 157
		sector_t start, unsigned int size)
{
	u64 end, bound;

	/* unaligned request */
	if (unlikely(start & (ZRAM_SECTOR_PER_LOGICAL_BLOCK - 1)))
158
		return false;
159
	if (unlikely(size & (ZRAM_LOGICAL_BLOCK_SIZE - 1)))
160
		return false;
161 162 163 164 165

	end = start + (size >> SECTOR_SHIFT);
	bound = zram->disksize >> SECTOR_SHIFT;
	/* out of range range */
	if (unlikely(start >= bound || end > bound || start > end))
166
		return false;
167 168

	/* I/O request is valid */
169
	return true;
170 171 172 173
}

static void update_position(u32 *index, int *offset, struct bio_vec *bvec)
{
174
	*index  += (*offset + bvec->bv_len) / PAGE_SIZE;
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192
	*offset = (*offset + bvec->bv_len) % PAGE_SIZE;
}

static inline void update_used_max(struct zram *zram,
					const unsigned long pages)
{
	unsigned long old_max, cur_max;

	old_max = atomic_long_read(&zram->stats.max_used_pages);

	do {
		cur_max = old_max;
		if (pages > cur_max)
			old_max = atomic_long_cmpxchg(
				&zram->stats.max_used_pages, cur_max, pages);
	} while (old_max != cur_max);
}

193
static inline void zram_fill_page(void *ptr, unsigned long len,
194 195 196
					unsigned long value)
{
	WARN_ON_ONCE(!IS_ALIGNED(len, sizeof(unsigned long)));
197
	memset_l(ptr, value, len / sizeof(unsigned long));
198 199 200
}

static bool page_same_filled(void *ptr, unsigned long *element)
201 202 203
{
	unsigned int pos;
	unsigned long *page;
204
	unsigned long val;
205 206

	page = (unsigned long *)ptr;
207
	val = page[0];
208

209 210
	for (pos = 1; pos < PAGE_SIZE / sizeof(*page); pos++) {
		if (val != page[pos])
211
			return false;
212 213
	}

214
	*element = val;
215

216
	return true;
217 218
}

219 220 221
static ssize_t initstate_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
222
	u32 val;
223 224
	struct zram *zram = dev_to_zram(dev);

225 226 227
	down_read(&zram->init_lock);
	val = init_done(zram);
	up_read(&zram->init_lock);
228

229
	return scnprintf(buf, PAGE_SIZE, "%u\n", val);
230 231
}

232 233 234 235 236 237 238 239
static ssize_t disksize_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct zram *zram = dev_to_zram(dev);

	return scnprintf(buf, PAGE_SIZE, "%llu\n", zram->disksize);
}

M
Minchan Kim 已提交
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
static ssize_t mem_limit_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t len)
{
	u64 limit;
	char *tmp;
	struct zram *zram = dev_to_zram(dev);

	limit = memparse(buf, &tmp);
	if (buf == tmp) /* no chars parsed, invalid input */
		return -EINVAL;

	down_write(&zram->init_lock);
	zram->limit_pages = PAGE_ALIGN(limit) >> PAGE_SHIFT;
	up_write(&zram->init_lock);

	return len;
}

M
Minchan Kim 已提交
258 259 260 261 262 263 264 265 266 267 268 269
static ssize_t mem_used_max_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t len)
{
	int err;
	unsigned long val;
	struct zram *zram = dev_to_zram(dev);

	err = kstrtoul(buf, 10, &val);
	if (err || val != 0)
		return -EINVAL;

	down_read(&zram->init_lock);
270
	if (init_done(zram)) {
M
Minchan Kim 已提交
271
		atomic_long_set(&zram->stats.max_used_pages,
M
Minchan Kim 已提交
272
				zs_get_total_pages(zram->mem_pool));
273
	}
M
Minchan Kim 已提交
274 275 276 277 278
	up_read(&zram->init_lock);

	return len;
}

279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
#ifdef CONFIG_ZRAM_WRITEBACK
static bool zram_wb_enabled(struct zram *zram)
{
	return zram->backing_dev;
}

static void reset_bdev(struct zram *zram)
{
	struct block_device *bdev;

	if (!zram_wb_enabled(zram))
		return;

	bdev = zram->bdev;
	if (zram->old_block_size)
		set_blocksize(bdev, zram->old_block_size);
	blkdev_put(bdev, FMODE_READ|FMODE_WRITE|FMODE_EXCL);
	/* hope filp_close flush all of IO */
	filp_close(zram->backing_dev, NULL);
	zram->backing_dev = NULL;
	zram->old_block_size = 0;
	zram->bdev = NULL;
301 302
	zram->disk->queue->backing_dev_info->capabilities |=
				BDI_CAP_SYNCHRONOUS_IO;
303 304
	kvfree(zram->bitmap);
	zram->bitmap = NULL;
305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339
}

static ssize_t backing_dev_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	struct zram *zram = dev_to_zram(dev);
	struct file *file = zram->backing_dev;
	char *p;
	ssize_t ret;

	down_read(&zram->init_lock);
	if (!zram_wb_enabled(zram)) {
		memcpy(buf, "none\n", 5);
		up_read(&zram->init_lock);
		return 5;
	}

	p = file_path(file, buf, PAGE_SIZE - 1);
	if (IS_ERR(p)) {
		ret = PTR_ERR(p);
		goto out;
	}

	ret = strlen(p);
	memmove(buf, p, ret);
	buf[ret++] = '\n';
out:
	up_read(&zram->init_lock);
	return ret;
}

static ssize_t backing_dev_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t len)
{
	char *file_name;
340
	size_t sz;
341 342 343
	struct file *backing_dev = NULL;
	struct inode *inode;
	struct address_space *mapping;
344 345
	unsigned int bitmap_sz, old_block_size = 0;
	unsigned long nr_pages, *bitmap = NULL;
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360
	struct block_device *bdev = NULL;
	int err;
	struct zram *zram = dev_to_zram(dev);

	file_name = kmalloc(PATH_MAX, GFP_KERNEL);
	if (!file_name)
		return -ENOMEM;

	down_write(&zram->init_lock);
	if (init_done(zram)) {
		pr_info("Can't setup backing device for initialized device\n");
		err = -EBUSY;
		goto out;
	}

361 362 363 364 365
	strlcpy(file_name, buf, PATH_MAX);
	/* ignore trailing newline */
	sz = strlen(file_name);
	if (sz > 0 && file_name[sz - 1] == '\n')
		file_name[sz - 1] = 0x00;
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387

	backing_dev = filp_open(file_name, O_RDWR|O_LARGEFILE, 0);
	if (IS_ERR(backing_dev)) {
		err = PTR_ERR(backing_dev);
		backing_dev = NULL;
		goto out;
	}

	mapping = backing_dev->f_mapping;
	inode = mapping->host;

	/* Support only block device in this moment */
	if (!S_ISBLK(inode->i_mode)) {
		err = -ENOTBLK;
		goto out;
	}

	bdev = bdgrab(I_BDEV(inode));
	err = blkdev_get(bdev, FMODE_READ | FMODE_WRITE | FMODE_EXCL, zram);
	if (err < 0)
		goto out;

388 389 390 391 392 393 394 395
	nr_pages = i_size_read(inode) >> PAGE_SHIFT;
	bitmap_sz = BITS_TO_LONGS(nr_pages) * sizeof(long);
	bitmap = kvzalloc(bitmap_sz, GFP_KERNEL);
	if (!bitmap) {
		err = -ENOMEM;
		goto out;
	}

396 397 398 399 400 401
	old_block_size = block_size(bdev);
	err = set_blocksize(bdev, PAGE_SIZE);
	if (err)
		goto out;

	reset_bdev(zram);
402
	spin_lock_init(&zram->bitmap_lock);
403 404 405 406

	zram->old_block_size = old_block_size;
	zram->bdev = bdev;
	zram->backing_dev = backing_dev;
407 408
	zram->bitmap = bitmap;
	zram->nr_pages = nr_pages;
409 410 411 412 413 414 415 416 417 418 419 420
	/*
	 * With writeback feature, zram does asynchronous IO so it's no longer
	 * synchronous device so let's remove synchronous io flag. Othewise,
	 * upper layer(e.g., swap) could wait IO completion rather than
	 * (submit and return), which will cause system sluggish.
	 * Furthermore, when the IO function returns(e.g., swap_readpage),
	 * upper layer expects IO was done so it could deallocate the page
	 * freely but in fact, IO is going on so finally could cause
	 * use-after-free when the IO is really done.
	 */
	zram->disk->queue->backing_dev_info->capabilities &=
			~BDI_CAP_SYNCHRONOUS_IO;
421 422 423 424 425 426 427
	up_write(&zram->init_lock);

	pr_info("setup backing device %s\n", file_name);
	kfree(file_name);

	return len;
out:
428 429 430
	if (bitmap)
		kvfree(bitmap);

431 432 433 434 435 436 437 438 439 440 441 442 443
	if (bdev)
		blkdev_put(bdev, FMODE_READ | FMODE_WRITE | FMODE_EXCL);

	if (backing_dev)
		filp_close(backing_dev, NULL);

	up_write(&zram->init_lock);

	kfree(file_name);

	return err;
}

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471
static unsigned long get_entry_bdev(struct zram *zram)
{
	unsigned long entry;

	spin_lock(&zram->bitmap_lock);
	/* skip 0 bit to confuse zram.handle = 0 */
	entry = find_next_zero_bit(zram->bitmap, zram->nr_pages, 1);
	if (entry == zram->nr_pages) {
		spin_unlock(&zram->bitmap_lock);
		return 0;
	}

	set_bit(entry, zram->bitmap);
	spin_unlock(&zram->bitmap_lock);

	return entry;
}

static void put_entry_bdev(struct zram *zram, unsigned long entry)
{
	int was_set;

	spin_lock(&zram->bitmap_lock);
	was_set = test_and_clear_bit(entry, zram->bitmap);
	spin_unlock(&zram->bitmap_lock);
	WARN_ON_ONCE(!was_set);
}

472
static void zram_page_end_io(struct bio *bio)
473
{
474
	struct page *page = bio_first_page_all(bio);
475 476 477 478 479 480

	page_endio(page, op_is_write(bio_op(bio)),
			blk_status_to_errno(bio->bi_status));
	bio_put(bio);
}

481 482 483 484 485 486 487 488 489 490 491 492 493
/*
 * Returns 1 if the submission is successful.
 */
static int read_from_bdev_async(struct zram *zram, struct bio_vec *bvec,
			unsigned long entry, struct bio *parent)
{
	struct bio *bio;

	bio = bio_alloc(GFP_ATOMIC, 1);
	if (!bio)
		return -ENOMEM;

	bio->bi_iter.bi_sector = entry * (PAGE_SIZE >> 9);
494
	bio_set_dev(bio, zram->bdev);
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
	if (!bio_add_page(bio, bvec->bv_page, bvec->bv_len, bvec->bv_offset)) {
		bio_put(bio);
		return -EIO;
	}

	if (!parent) {
		bio->bi_opf = REQ_OP_READ;
		bio->bi_end_io = zram_page_end_io;
	} else {
		bio->bi_opf = parent->bi_opf;
		bio_chain(bio, parent);
	}

	submit_bio(bio);
	return 1;
}

struct zram_work {
	struct work_struct work;
	struct zram *zram;
	unsigned long entry;
	struct bio *bio;
};

#if PAGE_SIZE != 4096
static void zram_sync_read(struct work_struct *work)
{
	struct bio_vec bvec;
	struct zram_work *zw = container_of(work, struct zram_work, work);
	struct zram *zram = zw->zram;
	unsigned long entry = zw->entry;
	struct bio *bio = zw->bio;

	read_from_bdev_async(zram, &bvec, entry, bio);
}

/*
 * Block layer want one ->make_request_fn to be active at a time
 * so if we use chained IO with parent IO in same context,
 * it's a deadlock. To avoid, it, it uses worker thread context.
 */
static int read_from_bdev_sync(struct zram *zram, struct bio_vec *bvec,
				unsigned long entry, struct bio *bio)
{
	struct zram_work work;

	work.zram = zram;
	work.entry = entry;
	work.bio = bio;

	INIT_WORK_ONSTACK(&work.work, zram_sync_read);
	queue_work(system_unbound_wq, &work.work);
	flush_work(&work.work);
	destroy_work_on_stack(&work.work);

	return 1;
}
#else
static int read_from_bdev_sync(struct zram *zram, struct bio_vec *bvec,
				unsigned long entry, struct bio *bio)
{
	WARN_ON(1);
	return -EIO;
}
#endif

static int read_from_bdev(struct zram *zram, struct bio_vec *bvec,
			unsigned long entry, struct bio *parent, bool sync)
{
	if (sync)
		return read_from_bdev_sync(zram, bvec, entry, parent);
	else
		return read_from_bdev_async(zram, bvec, entry, parent);
}

570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
static int write_to_bdev(struct zram *zram, struct bio_vec *bvec,
					u32 index, struct bio *parent,
					unsigned long *pentry)
{
	struct bio *bio;
	unsigned long entry;

	bio = bio_alloc(GFP_ATOMIC, 1);
	if (!bio)
		return -ENOMEM;

	entry = get_entry_bdev(zram);
	if (!entry) {
		bio_put(bio);
		return -ENOSPC;
	}

	bio->bi_iter.bi_sector = entry * (PAGE_SIZE >> 9);
588
	bio_set_dev(bio, zram->bdev);
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
	if (!bio_add_page(bio, bvec->bv_page, bvec->bv_len,
					bvec->bv_offset)) {
		bio_put(bio);
		put_entry_bdev(zram, entry);
		return -EIO;
	}

	if (!parent) {
		bio->bi_opf = REQ_OP_WRITE | REQ_SYNC;
		bio->bi_end_io = zram_page_end_io;
	} else {
		bio->bi_opf = parent->bi_opf;
		bio_chain(bio, parent);
	}

	submit_bio(bio);
	*pentry = entry;

	return 0;
}

static void zram_wb_clear(struct zram *zram, u32 index)
{
	unsigned long entry;

	zram_clear_flag(zram, index, ZRAM_WB);
	entry = zram_get_element(zram, index);
	zram_set_element(zram, index, 0);
	put_entry_bdev(zram, entry);
}

620 621 622
#else
static bool zram_wb_enabled(struct zram *zram) { return false; }
static inline void reset_bdev(struct zram *zram) {};
623 624 625 626 627 628 629
static int write_to_bdev(struct zram *zram, struct bio_vec *bvec,
					u32 index, struct bio *parent,
					unsigned long *pentry)

{
	return -EIO;
}
630 631 632 633 634 635

static int read_from_bdev(struct zram *zram, struct bio_vec *bvec,
			unsigned long entry, struct bio *parent, bool sync)
{
	return -EIO;
}
636
static void zram_wb_clear(struct zram *zram, u32 index) {}
637 638
#endif

639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
#ifdef CONFIG_ZRAM_MEMORY_TRACKING

static struct dentry *zram_debugfs_root;

static void zram_debugfs_create(void)
{
	zram_debugfs_root = debugfs_create_dir("zram", NULL);
}

static void zram_debugfs_destroy(void)
{
	debugfs_remove_recursive(zram_debugfs_root);
}

static void zram_accessed(struct zram *zram, u32 index)
{
	zram->table[index].ac_time = ktime_get_boottime();
}

static void zram_reset_access(struct zram *zram, u32 index)
{
	zram->table[index].ac_time = 0;
}

static ssize_t read_block_state(struct file *file, char __user *buf,
				size_t count, loff_t *ppos)
{
	char *kbuf;
	ssize_t index, written = 0;
	struct zram *zram = file->private_data;
	unsigned long nr_pages = zram->disksize >> PAGE_SHIFT;
	struct timespec64 ts;

	kbuf = kvmalloc(count, GFP_KERNEL);
	if (!kbuf)
		return -ENOMEM;

	down_read(&zram->init_lock);
	if (!init_done(zram)) {
		up_read(&zram->init_lock);
		kvfree(kbuf);
		return -EINVAL;
	}

	for (index = *ppos; index < nr_pages; index++) {
		int copied;

		zram_slot_lock(zram, index);
		if (!zram_allocated(zram, index))
			goto next;

		ts = ktime_to_timespec64(zram->table[index].ac_time);
		copied = snprintf(kbuf + written, count,
			"%12zd %12lld.%06lu %c%c%c\n",
			index, (s64)ts.tv_sec,
			ts.tv_nsec / NSEC_PER_USEC,
			zram_test_flag(zram, index, ZRAM_SAME) ? 's' : '.',
			zram_test_flag(zram, index, ZRAM_WB) ? 'w' : '.',
			zram_test_flag(zram, index, ZRAM_HUGE) ? 'h' : '.');

		if (count < copied) {
			zram_slot_unlock(zram, index);
			break;
		}
		written += copied;
		count -= copied;
next:
		zram_slot_unlock(zram, index);
		*ppos += 1;
	}

	up_read(&zram->init_lock);
	if (copy_to_user(buf, kbuf, written))
		written = -EFAULT;
	kvfree(kbuf);

	return written;
}

static const struct file_operations proc_zram_block_state_op = {
	.open = simple_open,
	.read = read_block_state,
	.llseek = default_llseek,
};

static void zram_debugfs_register(struct zram *zram)
{
	if (!zram_debugfs_root)
		return;

	zram->debugfs_dir = debugfs_create_dir(zram->disk->disk_name,
						zram_debugfs_root);
	debugfs_create_file("block_state", 0400, zram->debugfs_dir,
				zram, &proc_zram_block_state_op);
}

static void zram_debugfs_unregister(struct zram *zram)
{
	debugfs_remove_recursive(zram->debugfs_dir);
}
#else
static void zram_debugfs_create(void) {};
static void zram_debugfs_destroy(void) {};
static void zram_accessed(struct zram *zram, u32 index) {};
static void zram_reset_access(struct zram *zram, u32 index) {};
static void zram_debugfs_register(struct zram *zram) {};
static void zram_debugfs_unregister(struct zram *zram) {};
#endif
747

748 749 750 751 752 753 754 755 756
/*
 * We switched to per-cpu streams and this attr is not needed anymore.
 * However, we will keep it around for some time, because:
 * a) we may revert per-cpu streams in the future
 * b) it's visible to user space and we need to follow our 2 years
 *    retirement rule; but we already have a number of 'soon to be
 *    altered' attrs, so max_comp_streams need to wait for the next
 *    layoff cycle.
 */
757 758 759
static ssize_t max_comp_streams_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
760
	return scnprintf(buf, PAGE_SIZE, "%d\n", num_online_cpus());
761 762
}

763 764 765
static ssize_t max_comp_streams_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t len)
{
766
	return len;
767 768
}

769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785
static ssize_t comp_algorithm_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	size_t sz;
	struct zram *zram = dev_to_zram(dev);

	down_read(&zram->init_lock);
	sz = zcomp_available_show(zram->compressor, buf);
	up_read(&zram->init_lock);

	return sz;
}

static ssize_t comp_algorithm_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t len)
{
	struct zram *zram = dev_to_zram(dev);
786
	char compressor[ARRAY_SIZE(zram->compressor)];
787 788
	size_t sz;

789 790 791 792 793 794 795
	strlcpy(compressor, buf, sizeof(compressor));
	/* ignore trailing newline */
	sz = strlen(compressor);
	if (sz > 0 && compressor[sz - 1] == '\n')
		compressor[sz - 1] = 0x00;

	if (!zcomp_available_algorithm(compressor))
796 797
		return -EINVAL;

798 799 800 801 802 803
	down_write(&zram->init_lock);
	if (init_done(zram)) {
		up_write(&zram->init_lock);
		pr_info("Can't change algorithm for initialized device\n");
		return -EBUSY;
	}
804

805
	strcpy(zram->compressor, compressor);
806 807 808 809
	up_write(&zram->init_lock);
	return len;
}

810 811
static ssize_t compact_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t len)
812
{
813
	struct zram *zram = dev_to_zram(dev);
814

815 816 817 818 819
	down_read(&zram->init_lock);
	if (!init_done(zram)) {
		up_read(&zram->init_lock);
		return -EINVAL;
	}
820

M
Minchan Kim 已提交
821
	zs_compact(zram->mem_pool);
822
	up_read(&zram->init_lock);
823

824
	return len;
825 826
}

827 828
static ssize_t io_stat_show(struct device *dev,
		struct device_attribute *attr, char *buf)
829
{
830 831
	struct zram *zram = dev_to_zram(dev);
	ssize_t ret;
832

833 834 835 836 837 838 839 840
	down_read(&zram->init_lock);
	ret = scnprintf(buf, PAGE_SIZE,
			"%8llu %8llu %8llu %8llu\n",
			(u64)atomic64_read(&zram->stats.failed_reads),
			(u64)atomic64_read(&zram->stats.failed_writes),
			(u64)atomic64_read(&zram->stats.invalid_io),
			(u64)atomic64_read(&zram->stats.notify_free));
	up_read(&zram->init_lock);
841

842
	return ret;
843 844
}

845 846
static ssize_t mm_stat_show(struct device *dev,
		struct device_attribute *attr, char *buf)
847
{
848
	struct zram *zram = dev_to_zram(dev);
849
	struct zs_pool_stats pool_stats;
850 851 852
	u64 orig_size, mem_used = 0;
	long max_used;
	ssize_t ret;
853

854 855
	memset(&pool_stats, 0x00, sizeof(struct zs_pool_stats));

856
	down_read(&zram->init_lock);
857
	if (init_done(zram)) {
M
Minchan Kim 已提交
858 859
		mem_used = zs_get_total_pages(zram->mem_pool);
		zs_pool_stats(zram->mem_pool, &pool_stats);
860
	}
861

862 863
	orig_size = atomic64_read(&zram->stats.pages_stored);
	max_used = atomic_long_read(&zram->stats.max_used_pages);
864

865
	ret = scnprintf(buf, PAGE_SIZE,
866
			"%8llu %8llu %8llu %8lu %8ld %8llu %8lu %8llu\n",
867 868 869 870 871
			orig_size << PAGE_SHIFT,
			(u64)atomic64_read(&zram->stats.compr_data_size),
			mem_used << PAGE_SHIFT,
			zram->limit_pages << PAGE_SHIFT,
			max_used << PAGE_SHIFT,
872
			(u64)atomic64_read(&zram->stats.same_pages),
873 874
			pool_stats.pages_compacted,
			(u64)atomic64_read(&zram->stats.huge_pages));
875
	up_read(&zram->init_lock);
876

877 878 879
	return ret;
}

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896
static ssize_t debug_stat_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	int version = 1;
	struct zram *zram = dev_to_zram(dev);
	ssize_t ret;

	down_read(&zram->init_lock);
	ret = scnprintf(buf, PAGE_SIZE,
			"version: %d\n%8llu\n",
			version,
			(u64)atomic64_read(&zram->stats.writestall));
	up_read(&zram->init_lock);

	return ret;
}

897 898
static DEVICE_ATTR_RO(io_stat);
static DEVICE_ATTR_RO(mm_stat);
899
static DEVICE_ATTR_RO(debug_stat);
900

M
Minchan Kim 已提交
901
static void zram_meta_free(struct zram *zram, u64 disksize)
902 903 904
{
	size_t num_pages = disksize >> PAGE_SHIFT;
	size_t index;
905 906

	/* Free all pages that are still in this zram device */
907 908
	for (index = 0; index < num_pages; index++)
		zram_free_page(zram, index);
909

M
Minchan Kim 已提交
910 911
	zs_destroy_pool(zram->mem_pool);
	vfree(zram->table);
912 913
}

M
Minchan Kim 已提交
914
static bool zram_meta_alloc(struct zram *zram, u64 disksize)
915 916 917 918
{
	size_t num_pages;

	num_pages = disksize >> PAGE_SHIFT;
919
	zram->table = vzalloc(array_size(num_pages, sizeof(*zram->table)));
M
Minchan Kim 已提交
920 921
	if (!zram->table)
		return false;
922

M
Minchan Kim 已提交
923 924 925 926
	zram->mem_pool = zs_create_pool(zram->disk->disk_name);
	if (!zram->mem_pool) {
		vfree(zram->table);
		return false;
927 928
	}

929 930
	if (!huge_class_size)
		huge_class_size = zs_huge_class_size(zram->mem_pool);
M
Minchan Kim 已提交
931
	return true;
932 933
}

934 935 936 937 938
/*
 * To protect concurrent access to the same index entry,
 * caller should hold this table index entry's bit_spinlock to
 * indicate this index entry is accessing.
 */
939
static void zram_free_page(struct zram *zram, size_t index)
940
{
941 942
	unsigned long handle;

M
Minchan Kim 已提交
943 944
	zram_reset_access(zram, index);

945 946 947 948 949
	if (zram_test_flag(zram, index, ZRAM_HUGE)) {
		zram_clear_flag(zram, index, ZRAM_HUGE);
		atomic64_dec(&zram->stats.huge_pages);
	}

950 951 952 953 954
	if (zram_wb_enabled(zram) && zram_test_flag(zram, index, ZRAM_WB)) {
		zram_wb_clear(zram, index);
		atomic64_dec(&zram->stats.pages_stored);
		return;
	}
955

956 957 958 959
	/*
	 * No memory is allocated for same element filled pages.
	 * Simply clear same page flag.
	 */
M
Minchan Kim 已提交
960 961
	if (zram_test_flag(zram, index, ZRAM_SAME)) {
		zram_clear_flag(zram, index, ZRAM_SAME);
M
Minchan Kim 已提交
962
		zram_set_element(zram, index, 0);
963
		atomic64_dec(&zram->stats.same_pages);
964
		atomic64_dec(&zram->stats.pages_stored);
965 966 967
		return;
	}

968
	handle = zram_get_handle(zram, index);
969 970 971
	if (!handle)
		return;

M
Minchan Kim 已提交
972
	zs_free(zram->mem_pool, handle);
973

M
Minchan Kim 已提交
974
	atomic64_sub(zram_get_obj_size(zram, index),
975
			&zram->stats.compr_data_size);
976
	atomic64_dec(&zram->stats.pages_stored);
977

M
Minchan Kim 已提交
978
	zram_set_handle(zram, index, 0);
M
Minchan Kim 已提交
979
	zram_set_obj_size(zram, index, 0);
980 981
}

982 983
static int __zram_bvec_read(struct zram *zram, struct page *page, u32 index,
				struct bio *bio, bool partial_io)
984
{
M
Minchan Kim 已提交
985
	int ret;
M
Minchan Kim 已提交
986
	unsigned long handle;
987
	unsigned int size;
M
Minchan Kim 已提交
988 989
	void *src, *dst;

990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006
	if (zram_wb_enabled(zram)) {
		zram_slot_lock(zram, index);
		if (zram_test_flag(zram, index, ZRAM_WB)) {
			struct bio_vec bvec;

			zram_slot_unlock(zram, index);

			bvec.bv_page = page;
			bvec.bv_len = PAGE_SIZE;
			bvec.bv_offset = 0;
			return read_from_bdev(zram, &bvec,
					zram_get_element(zram, index),
					bio, partial_io);
		}
		zram_slot_unlock(zram, index);
	}

1007
	zram_slot_lock(zram, index);
M
Minchan Kim 已提交
1008
	handle = zram_get_handle(zram, index);
M
Minchan Kim 已提交
1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020
	if (!handle || zram_test_flag(zram, index, ZRAM_SAME)) {
		unsigned long value;
		void *mem;

		value = handle ? zram_get_element(zram, index) : 0;
		mem = kmap_atomic(page);
		zram_fill_page(mem, PAGE_SIZE, value);
		kunmap_atomic(mem);
		zram_slot_unlock(zram, index);
		return 0;
	}

M
Minchan Kim 已提交
1021
	size = zram_get_obj_size(zram, index);
1022

M
Minchan Kim 已提交
1023
	src = zs_map_object(zram->mem_pool, handle, ZS_MM_RO);
1024
	if (size == PAGE_SIZE) {
M
Minchan Kim 已提交
1025 1026 1027 1028
		dst = kmap_atomic(page);
		memcpy(dst, src, PAGE_SIZE);
		kunmap_atomic(dst);
		ret = 0;
1029 1030 1031
	} else {
		struct zcomp_strm *zstrm = zcomp_stream_get(zram->comp);

M
Minchan Kim 已提交
1032 1033 1034
		dst = kmap_atomic(page);
		ret = zcomp_decompress(zstrm, src, size, dst);
		kunmap_atomic(dst);
1035 1036
		zcomp_stream_put(zram->comp);
	}
M
Minchan Kim 已提交
1037
	zs_unmap_object(zram->mem_pool, handle);
1038
	zram_slot_unlock(zram, index);
1039

1040
	/* Should NEVER happen. Return bio error if it does. */
M
Minchan Kim 已提交
1041
	if (unlikely(ret))
1042
		pr_err("Decompression failed! err=%d, page=%u\n", ret, index);
1043

M
Minchan Kim 已提交
1044
	return ret;
1045 1046
}

1047
static int zram_bvec_read(struct zram *zram, struct bio_vec *bvec,
1048
				u32 index, int offset, struct bio *bio)
1049 1050
{
	int ret;
1051 1052
	struct page *page;

M
Minchan Kim 已提交
1053 1054 1055 1056 1057 1058
	page = bvec->bv_page;
	if (is_partial_io(bvec)) {
		/* Use a temporary buffer to decompress the page */
		page = alloc_page(GFP_NOIO|__GFP_HIGHMEM);
		if (!page)
			return -ENOMEM;
1059 1060
	}

1061
	ret = __zram_bvec_read(zram, page, index, bio, is_partial_io(bvec));
M
Minchan Kim 已提交
1062 1063
	if (unlikely(ret))
		goto out;
1064

M
Minchan Kim 已提交
1065 1066 1067
	if (is_partial_io(bvec)) {
		void *dst = kmap_atomic(bvec->bv_page);
		void *src = kmap_atomic(page);
1068

M
Minchan Kim 已提交
1069 1070 1071
		memcpy(dst + bvec->bv_offset, src + offset, bvec->bv_len);
		kunmap_atomic(src);
		kunmap_atomic(dst);
1072
	}
M
Minchan Kim 已提交
1073
out:
1074
	if (is_partial_io(bvec))
M
Minchan Kim 已提交
1075
		__free_page(page);
1076 1077

	return ret;
1078 1079
}

1080 1081
static int __zram_bvec_write(struct zram *zram, struct bio_vec *bvec,
				u32 index, struct bio *bio)
1082
{
1083
	int ret = 0;
M
Minchan Kim 已提交
1084
	unsigned long alloced_pages;
1085
	unsigned long handle = 0;
M
Minchan Kim 已提交
1086 1087 1088 1089 1090 1091
	unsigned int comp_len = 0;
	void *src, *dst, *mem;
	struct zcomp_strm *zstrm;
	struct page *page = bvec->bv_page;
	unsigned long element = 0;
	enum zram_pageflags flags = 0;
1092
	bool allow_wb = true;
M
Minchan Kim 已提交
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102

	mem = kmap_atomic(page);
	if (page_same_filled(mem, &element)) {
		kunmap_atomic(mem);
		/* Free memory associated with this sector now. */
		flags = ZRAM_SAME;
		atomic64_inc(&zram->stats.same_pages);
		goto out;
	}
	kunmap_atomic(mem);
1103

1104
compress_again:
M
Minchan Kim 已提交
1105
	zstrm = zcomp_stream_get(zram->comp);
M
Minchan Kim 已提交
1106
	src = kmap_atomic(page);
M
Minchan Kim 已提交
1107
	ret = zcomp_compress(zstrm, src, &comp_len);
M
Minchan Kim 已提交
1108
	kunmap_atomic(src);
1109

1110
	if (unlikely(ret)) {
M
Minchan Kim 已提交
1111
		zcomp_stream_put(zram->comp);
1112
		pr_err("Compression failed! err=%d\n", ret);
M
Minchan Kim 已提交
1113
		zs_free(zram->mem_pool, handle);
M
Minchan Kim 已提交
1114
		return ret;
1115
	}
1116

1117
	if (unlikely(comp_len >= huge_class_size)) {
1118
		comp_len = PAGE_SIZE;
1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130
		if (zram_wb_enabled(zram) && allow_wb) {
			zcomp_stream_put(zram->comp);
			ret = write_to_bdev(zram, bvec, index, bio, &element);
			if (!ret) {
				flags = ZRAM_WB;
				ret = 1;
				goto out;
			}
			allow_wb = false;
			goto compress_again;
		}
	}
1131

1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
	/*
	 * handle allocation has 2 paths:
	 * a) fast path is executed with preemption disabled (for
	 *  per-cpu streams) and has __GFP_DIRECT_RECLAIM bit clear,
	 *  since we can't sleep;
	 * b) slow path enables preemption and attempts to allocate
	 *  the page with __GFP_DIRECT_RECLAIM bit set. we have to
	 *  put per-cpu compression stream and, thus, to re-do
	 *  the compression once handle is allocated.
	 *
	 * if we have a 'non-null' handle here then we are coming
	 * from the slow path and handle has already been allocated.
	 */
	if (!handle)
M
Minchan Kim 已提交
1146
		handle = zs_malloc(zram->mem_pool, comp_len,
1147 1148
				__GFP_KSWAPD_RECLAIM |
				__GFP_NOWARN |
1149 1150
				__GFP_HIGHMEM |
				__GFP_MOVABLE);
1151
	if (!handle) {
1152
		zcomp_stream_put(zram->comp);
1153
		atomic64_inc(&zram->stats.writestall);
M
Minchan Kim 已提交
1154
		handle = zs_malloc(zram->mem_pool, comp_len,
1155 1156
				GFP_NOIO | __GFP_HIGHMEM |
				__GFP_MOVABLE);
1157 1158
		if (handle)
			goto compress_again;
M
Minchan Kim 已提交
1159
		return -ENOMEM;
1160
	}
M
Minchan Kim 已提交
1161

M
Minchan Kim 已提交
1162
	alloced_pages = zs_get_total_pages(zram->mem_pool);
1163 1164
	update_used_max(zram, alloced_pages);

M
Minchan Kim 已提交
1165
	if (zram->limit_pages && alloced_pages > zram->limit_pages) {
M
Minchan Kim 已提交
1166
		zcomp_stream_put(zram->comp);
M
Minchan Kim 已提交
1167
		zs_free(zram->mem_pool, handle);
M
Minchan Kim 已提交
1168 1169 1170
		return -ENOMEM;
	}

M
Minchan Kim 已提交
1171
	dst = zs_map_object(zram->mem_pool, handle, ZS_MM_WO);
M
Minchan Kim 已提交
1172 1173 1174

	src = zstrm->buffer;
	if (comp_len == PAGE_SIZE)
1175
		src = kmap_atomic(page);
M
Minchan Kim 已提交
1176 1177
	memcpy(dst, src, comp_len);
	if (comp_len == PAGE_SIZE)
1178
		kunmap_atomic(src);
1179

1180
	zcomp_stream_put(zram->comp);
M
Minchan Kim 已提交
1181
	zs_unmap_object(zram->mem_pool, handle);
1182 1183
	atomic64_add(comp_len, &zram->stats.compr_data_size);
out:
1184 1185 1186 1187
	/*
	 * Free memory associated with this sector
	 * before overwriting unused sectors.
	 */
1188
	zram_slot_lock(zram, index);
1189
	zram_free_page(zram, index);
1190

1191 1192 1193 1194 1195
	if (comp_len == PAGE_SIZE) {
		zram_set_flag(zram, index, ZRAM_HUGE);
		atomic64_inc(&zram->stats.huge_pages);
	}

1196 1197
	if (flags) {
		zram_set_flag(zram, index, flags);
1198
		zram_set_element(zram, index, element);
1199
	}  else {
1200 1201 1202
		zram_set_handle(zram, index, handle);
		zram_set_obj_size(zram, index, comp_len);
	}
1203
	zram_slot_unlock(zram, index);
1204

1205
	/* Update stats */
1206
	atomic64_inc(&zram->stats.pages_stored);
1207
	return ret;
M
Minchan Kim 已提交
1208 1209 1210
}

static int zram_bvec_write(struct zram *zram, struct bio_vec *bvec,
1211
				u32 index, int offset, struct bio *bio)
M
Minchan Kim 已提交
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228
{
	int ret;
	struct page *page = NULL;
	void *src;
	struct bio_vec vec;

	vec = *bvec;
	if (is_partial_io(bvec)) {
		void *dst;
		/*
		 * This is a partial IO. We need to read the full page
		 * before to write the changes.
		 */
		page = alloc_page(GFP_NOIO|__GFP_HIGHMEM);
		if (!page)
			return -ENOMEM;

1229
		ret = __zram_bvec_read(zram, page, index, bio, true);
M
Minchan Kim 已提交
1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243
		if (ret)
			goto out;

		src = kmap_atomic(bvec->bv_page);
		dst = kmap_atomic(page);
		memcpy(dst + offset, src + bvec->bv_offset, bvec->bv_len);
		kunmap_atomic(dst);
		kunmap_atomic(src);

		vec.bv_page = page;
		vec.bv_len = PAGE_SIZE;
		vec.bv_offset = 0;
	}

1244
	ret = __zram_bvec_write(zram, &vec, index, bio);
1245
out:
1246
	if (is_partial_io(bvec))
M
Minchan Kim 已提交
1247
		__free_page(page);
1248
	return ret;
1249 1250
}

J
Joonsoo Kim 已提交
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271
/*
 * zram_bio_discard - handler on discard request
 * @index: physical block index in PAGE_SIZE units
 * @offset: byte offset within physical block
 */
static void zram_bio_discard(struct zram *zram, u32 index,
			     int offset, struct bio *bio)
{
	size_t n = bio->bi_iter.bi_size;

	/*
	 * zram manages data in physical block size units. Because logical block
	 * size isn't identical with physical block size on some arch, we
	 * could get a discard request pointing to a specific offset within a
	 * certain physical block.  Although we can handle this request by
	 * reading that physiclal block and decompressing and partially zeroing
	 * and re-compressing and then re-storing it, this isn't reasonable
	 * because our intent with a discard request is to save memory.  So
	 * skipping this logical block is appropriate here.
	 */
	if (offset) {
1272
		if (n <= (PAGE_SIZE - offset))
J
Joonsoo Kim 已提交
1273 1274
			return;

1275
		n -= (PAGE_SIZE - offset);
J
Joonsoo Kim 已提交
1276 1277 1278 1279
		index++;
	}

	while (n >= PAGE_SIZE) {
1280
		zram_slot_lock(zram, index);
J
Joonsoo Kim 已提交
1281
		zram_free_page(zram, index);
1282
		zram_slot_unlock(zram, index);
1283
		atomic64_inc(&zram->stats.notify_free);
J
Joonsoo Kim 已提交
1284 1285 1286 1287 1288
		index++;
		n -= PAGE_SIZE;
	}
}

1289 1290 1291 1292 1293
/*
 * Returns errno if it has some problem. Otherwise return 0 or 1.
 * Returns 0 if IO request was done synchronously
 * Returns 1 if IO request was successfully submitted.
 */
1294
static int zram_bvec_rw(struct zram *zram, struct bio_vec *bvec, u32 index,
1295
			int offset, unsigned int op, struct bio *bio)
1296
{
1297
	unsigned long start_time = jiffies;
1298
	struct request_queue *q = zram->disk->queue;
1299 1300
	int ret;

1301
	generic_start_io_acct(q, op, bvec->bv_len >> SECTOR_SHIFT,
1302
			&zram->disk->part0);
1303

1304
	if (!op_is_write(op)) {
1305
		atomic64_inc(&zram->stats.num_reads);
1306
		ret = zram_bvec_read(zram, bvec, index, offset, bio);
M
Minchan Kim 已提交
1307
		flush_dcache_page(bvec->bv_page);
1308 1309
	} else {
		atomic64_inc(&zram->stats.num_writes);
1310
		ret = zram_bvec_write(zram, bvec, index, offset, bio);
1311
	}
1312

1313
	generic_end_io_acct(q, op, &zram->disk->part0, start_time);
1314

M
Minchan Kim 已提交
1315 1316 1317 1318
	zram_slot_lock(zram, index);
	zram_accessed(zram, index);
	zram_slot_unlock(zram, index);

1319
	if (unlikely(ret < 0)) {
1320
		if (!op_is_write(op))
1321 1322 1323
			atomic64_inc(&zram->stats.failed_reads);
		else
			atomic64_inc(&zram->stats.failed_writes);
1324
	}
1325

1326
	return ret;
1327 1328
}

1329
static void __zram_make_request(struct zram *zram, struct bio *bio)
1330
{
1331
	int offset;
1332
	u32 index;
1333 1334
	struct bio_vec bvec;
	struct bvec_iter iter;
1335

1336 1337 1338
	index = bio->bi_iter.bi_sector >> SECTORS_PER_PAGE_SHIFT;
	offset = (bio->bi_iter.bi_sector &
		  (SECTORS_PER_PAGE - 1)) << SECTOR_SHIFT;
1339

1340 1341 1342
	switch (bio_op(bio)) {
	case REQ_OP_DISCARD:
	case REQ_OP_WRITE_ZEROES:
J
Joonsoo Kim 已提交
1343
		zram_bio_discard(zram, index, offset, bio);
1344
		bio_endio(bio);
J
Joonsoo Kim 已提交
1345
		return;
1346 1347
	default:
		break;
J
Joonsoo Kim 已提交
1348 1349
	}

1350
	bio_for_each_segment(bvec, bio, iter) {
1351 1352
		struct bio_vec bv = bvec;
		unsigned int unwritten = bvec.bv_len;
1353

1354 1355 1356
		do {
			bv.bv_len = min_t(unsigned int, PAGE_SIZE - offset,
							unwritten);
1357
			if (zram_bvec_rw(zram, &bv, index, offset,
1358
					 bio_op(bio), bio) < 0)
1359 1360
				goto out;

1361 1362
			bv.bv_offset += bv.bv_len;
			unwritten -= bv.bv_len;
1363

1364 1365
			update_position(&index, &offset, &bv);
		} while (unwritten);
1366
	}
1367

1368
	bio_endio(bio);
1369
	return;
1370 1371 1372 1373 1374 1375

out:
	bio_io_error(bio);
}

/*
1376
 * Handler function for all zram I/O requests.
1377
 */
1378
static blk_qc_t zram_make_request(struct request_queue *queue, struct bio *bio)
1379
{
1380
	struct zram *zram = queue->queuedata;
1381

1382 1383
	if (!valid_io_request(zram, bio->bi_iter.bi_sector,
					bio->bi_iter.bi_size)) {
1384
		atomic64_inc(&zram->stats.invalid_io);
M
Minchan Kim 已提交
1385
		goto error;
1386 1387
	}

1388
	__zram_make_request(zram, bio);
1389
	return BLK_QC_T_NONE;
M
Minchan Kim 已提交
1390

1391 1392
error:
	bio_io_error(bio);
1393
	return BLK_QC_T_NONE;
1394 1395
}

N
Nitin Gupta 已提交
1396 1397
static void zram_slot_free_notify(struct block_device *bdev,
				unsigned long index)
1398
{
1399
	struct zram *zram;
1400

1401
	zram = bdev->bd_disk->private_data;
1402

1403
	zram_slot_lock(zram, index);
1404
	zram_free_page(zram, index);
1405
	zram_slot_unlock(zram, index);
1406
	atomic64_inc(&zram->stats.notify_free);
1407 1408
}

1409
static int zram_rw_page(struct block_device *bdev, sector_t sector,
1410
		       struct page *page, unsigned int op)
1411
{
1412
	int offset, ret;
1413 1414 1415 1416
	u32 index;
	struct zram *zram;
	struct bio_vec bv;

1417 1418
	if (PageTransHuge(page))
		return -ENOTSUPP;
1419
	zram = bdev->bd_disk->private_data;
1420

1421 1422
	if (!valid_io_request(zram, sector, PAGE_SIZE)) {
		atomic64_inc(&zram->stats.invalid_io);
1423
		ret = -EINVAL;
M
Minchan Kim 已提交
1424
		goto out;
1425 1426 1427
	}

	index = sector >> SECTORS_PER_PAGE_SHIFT;
1428
	offset = (sector & (SECTORS_PER_PAGE - 1)) << SECTOR_SHIFT;
1429 1430 1431 1432 1433

	bv.bv_page = page;
	bv.bv_len = PAGE_SIZE;
	bv.bv_offset = 0;

1434
	ret = zram_bvec_rw(zram, &bv, index, offset, op, NULL);
1435
out:
1436 1437 1438 1439 1440 1441 1442 1443
	/*
	 * If I/O fails, just return error(ie, non-zero) without
	 * calling page_endio.
	 * It causes resubmit the I/O with bio request by upper functions
	 * of rw_page(e.g., swap_readpage, __swap_writepage) and
	 * bio->bi_end_io does things to handle the error
	 * (e.g., SetPageError, set_page_dirty and extra works).
	 */
1444 1445 1446 1447 1448
	if (unlikely(ret < 0))
		return ret;

	switch (ret) {
	case 0:
1449
		page_endio(page, op_is_write(op), 0);
1450 1451 1452 1453 1454 1455 1456 1457
		break;
	case 1:
		ret = 0;
		break;
	default:
		WARN_ON(1);
	}
	return ret;
1458 1459
}

1460 1461 1462 1463
static void zram_reset_device(struct zram *zram)
{
	struct zcomp *comp;
	u64 disksize;
1464

1465
	down_write(&zram->init_lock);
1466

1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482
	zram->limit_pages = 0;

	if (!init_done(zram)) {
		up_write(&zram->init_lock);
		return;
	}

	comp = zram->comp;
	disksize = zram->disksize;
	zram->disksize = 0;

	set_capacity(zram->disk, 0);
	part_stat_set_all(&zram->disk->part0, 0);

	up_write(&zram->init_lock);
	/* I/O operation under all of CPU are done so let's free */
M
Minchan Kim 已提交
1483
	zram_meta_free(zram, disksize);
1484
	memset(&zram->stats, 0, sizeof(zram->stats));
1485
	zcomp_destroy(comp);
1486
	reset_bdev(zram);
1487 1488 1489 1490
}

static ssize_t disksize_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t len)
1491
{
1492 1493
	u64 disksize;
	struct zcomp *comp;
1494
	struct zram *zram = dev_to_zram(dev);
1495
	int err;
1496

1497 1498 1499
	disksize = memparse(buf, NULL);
	if (!disksize)
		return -EINVAL;
1500

M
Minchan Kim 已提交
1501 1502 1503 1504 1505 1506 1507
	down_write(&zram->init_lock);
	if (init_done(zram)) {
		pr_info("Cannot change disksize for initialized device\n");
		err = -EBUSY;
		goto out_unlock;
	}

1508
	disksize = PAGE_ALIGN(disksize);
M
Minchan Kim 已提交
1509 1510 1511 1512
	if (!zram_meta_alloc(zram, disksize)) {
		err = -ENOMEM;
		goto out_unlock;
	}
1513

1514
	comp = zcomp_create(zram->compressor);
1515
	if (IS_ERR(comp)) {
S
Sergey Senozhatsky 已提交
1516
		pr_err("Cannot initialise %s compressing backend\n",
1517 1518 1519 1520 1521 1522 1523 1524
				zram->compressor);
		err = PTR_ERR(comp);
		goto out_free_meta;
	}

	zram->comp = comp;
	zram->disksize = disksize;
	set_capacity(zram->disk, zram->disksize >> SECTOR_SHIFT);
M
Minchan Kim 已提交
1525 1526

	revalidate_disk(zram->disk);
1527
	up_write(&zram->init_lock);
1528 1529 1530 1531

	return len;

out_free_meta:
M
Minchan Kim 已提交
1532 1533 1534
	zram_meta_free(zram, disksize);
out_unlock:
	up_write(&zram->init_lock);
1535
	return err;
1536 1537
}

1538 1539
static ssize_t reset_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t len)
1540
{
1541 1542 1543 1544
	int ret;
	unsigned short do_reset;
	struct zram *zram;
	struct block_device *bdev;
1545

1546 1547 1548 1549 1550 1551 1552
	ret = kstrtou16(buf, 10, &do_reset);
	if (ret)
		return ret;

	if (!do_reset)
		return -EINVAL;

1553 1554 1555 1556
	zram = dev_to_zram(dev);
	bdev = bdget_disk(zram->disk, 0);
	if (!bdev)
		return -ENOMEM;
1557

1558
	mutex_lock(&bdev->bd_mutex);
1559 1560 1561 1562 1563
	/* Do not reset an active device or claimed device */
	if (bdev->bd_openers || zram->claim) {
		mutex_unlock(&bdev->bd_mutex);
		bdput(bdev);
		return -EBUSY;
1564 1565
	}

1566 1567 1568
	/* From now on, anyone can't open /dev/zram[0-9] */
	zram->claim = true;
	mutex_unlock(&bdev->bd_mutex);
1569

1570
	/* Make sure all the pending I/O are finished */
1571 1572
	fsync_bdev(bdev);
	zram_reset_device(zram);
M
Minchan Kim 已提交
1573
	revalidate_disk(zram->disk);
1574 1575
	bdput(bdev);

1576 1577 1578 1579
	mutex_lock(&bdev->bd_mutex);
	zram->claim = false;
	mutex_unlock(&bdev->bd_mutex);

1580
	return len;
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
}

static int zram_open(struct block_device *bdev, fmode_t mode)
{
	int ret = 0;
	struct zram *zram;

	WARN_ON(!mutex_is_locked(&bdev->bd_mutex));

	zram = bdev->bd_disk->private_data;
	/* zram was claimed to reset so open request fails */
	if (zram->claim)
		ret = -EBUSY;
1594 1595 1596 1597

	return ret;
}

1598
static const struct block_device_operations zram_devops = {
1599
	.open = zram_open,
1600 1601 1602 1603 1604 1605 1606 1607 1608
	.swap_slot_free_notify = zram_slot_free_notify,
	.rw_page = zram_rw_page,
	.owner = THIS_MODULE
};

static DEVICE_ATTR_WO(compact);
static DEVICE_ATTR_RW(disksize);
static DEVICE_ATTR_RO(initstate);
static DEVICE_ATTR_WO(reset);
1609 1610
static DEVICE_ATTR_WO(mem_limit);
static DEVICE_ATTR_WO(mem_used_max);
1611 1612
static DEVICE_ATTR_RW(max_comp_streams);
static DEVICE_ATTR_RW(comp_algorithm);
1613 1614 1615
#ifdef CONFIG_ZRAM_WRITEBACK
static DEVICE_ATTR_RW(backing_dev);
#endif
1616

1617 1618 1619 1620
static struct attribute *zram_disk_attrs[] = {
	&dev_attr_disksize.attr,
	&dev_attr_initstate.attr,
	&dev_attr_reset.attr,
1621
	&dev_attr_compact.attr,
M
Minchan Kim 已提交
1622
	&dev_attr_mem_limit.attr,
M
Minchan Kim 已提交
1623
	&dev_attr_mem_used_max.attr,
1624
	&dev_attr_max_comp_streams.attr,
1625
	&dev_attr_comp_algorithm.attr,
1626 1627 1628
#ifdef CONFIG_ZRAM_WRITEBACK
	&dev_attr_backing_dev.attr,
#endif
1629
	&dev_attr_io_stat.attr,
1630
	&dev_attr_mm_stat.attr,
1631
	&dev_attr_debug_stat.attr,
1632 1633 1634
	NULL,
};

1635
static const struct attribute_group zram_disk_attr_group = {
1636 1637 1638
	.attrs = zram_disk_attrs,
};

1639 1640 1641 1642 1643
/*
 * Allocate and initialize new zram device. the function returns
 * '>= 0' device_id upon success, and negative value otherwise.
 */
static int zram_add(void)
1644
{
1645
	struct zram *zram;
1646
	struct request_queue *queue;
1647
	int ret, device_id;
1648 1649 1650 1651 1652

	zram = kzalloc(sizeof(struct zram), GFP_KERNEL);
	if (!zram)
		return -ENOMEM;

1653
	ret = idr_alloc(&zram_index_idr, zram, 0, 0, GFP_KERNEL);
1654 1655
	if (ret < 0)
		goto out_free_dev;
1656
	device_id = ret;
1657

1658
	init_rwsem(&zram->init_lock);
1659

1660 1661
	queue = blk_alloc_queue(GFP_KERNEL);
	if (!queue) {
1662 1663
		pr_err("Error allocating disk queue for device %d\n",
			device_id);
1664 1665
		ret = -ENOMEM;
		goto out_free_idr;
1666 1667
	}

1668
	blk_queue_make_request(queue, zram_make_request);
1669

1670
	/* gendisk structure */
1671 1672
	zram->disk = alloc_disk(1);
	if (!zram->disk) {
S
Sergey Senozhatsky 已提交
1673
		pr_err("Error allocating disk structure for device %d\n",
1674
			device_id);
J
Julia Lawall 已提交
1675
		ret = -ENOMEM;
1676
		goto out_free_queue;
1677 1678
	}

1679 1680 1681
	zram->disk->major = zram_major;
	zram->disk->first_minor = device_id;
	zram->disk->fops = &zram_devops;
1682 1683
	zram->disk->queue = queue;
	zram->disk->queue->queuedata = zram;
1684 1685
	zram->disk->private_data = zram;
	snprintf(zram->disk->disk_name, 16, "zram%d", device_id);
1686

1687
	/* Actual capacity set using syfs (/sys/block/zram<id>/disksize */
1688
	set_capacity(zram->disk, 0);
1689
	/* zram devices sort of resembles non-rotational disks */
1690 1691
	blk_queue_flag_set(QUEUE_FLAG_NONROT, zram->disk->queue);
	blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, zram->disk->queue);
M
Minchan Kim 已提交
1692

1693 1694 1695 1696
	/*
	 * To ensure that we always get PAGE_SIZE aligned
	 * and n*PAGE_SIZED sized I/O requests.
	 */
1697
	blk_queue_physical_block_size(zram->disk->queue, PAGE_SIZE);
1698 1699
	blk_queue_logical_block_size(zram->disk->queue,
					ZRAM_LOGICAL_BLOCK_SIZE);
1700 1701
	blk_queue_io_min(zram->disk->queue, PAGE_SIZE);
	blk_queue_io_opt(zram->disk->queue, PAGE_SIZE);
J
Joonsoo Kim 已提交
1702
	zram->disk->queue->limits.discard_granularity = PAGE_SIZE;
1703
	blk_queue_max_discard_sectors(zram->disk->queue, UINT_MAX);
1704
	blk_queue_flag_set(QUEUE_FLAG_DISCARD, zram->disk->queue);
1705

J
Joonsoo Kim 已提交
1706 1707 1708 1709 1710 1711 1712 1713 1714
	/*
	 * zram_bio_discard() will clear all logical blocks if logical block
	 * size is identical with physical block size(PAGE_SIZE). But if it is
	 * different, we will skip discarding some parts of logical blocks in
	 * the part of the request range which isn't aligned to physical block
	 * size.  So we can't ensure that all discarded logical blocks are
	 * zeroed.
	 */
	if (ZRAM_LOGICAL_BLOCK_SIZE == PAGE_SIZE)
1715
		blk_queue_max_write_zeroes_sectors(zram->disk->queue, UINT_MAX);
1716

M
Minchan Kim 已提交
1717
	zram->disk->queue->backing_dev_info->capabilities |=
1718
			(BDI_CAP_STABLE_WRITES | BDI_CAP_SYNCHRONOUS_IO);
1719
	add_disk(zram->disk);
1720

1721 1722 1723
	ret = sysfs_create_group(&disk_to_dev(zram->disk)->kobj,
				&zram_disk_attr_group);
	if (ret < 0) {
S
Sergey Senozhatsky 已提交
1724 1725
		pr_err("Error creating sysfs group for device %d\n",
				device_id);
1726
		goto out_free_disk;
1727
	}
1728
	strlcpy(zram->compressor, default_compressor, sizeof(zram->compressor));
1729

1730
	zram_debugfs_register(zram);
1731
	pr_info("Added device: %s\n", zram->disk->disk_name);
1732
	return device_id;
1733

1734 1735 1736 1737
out_free_disk:
	del_gendisk(zram->disk);
	put_disk(zram->disk);
out_free_queue:
1738
	blk_cleanup_queue(queue);
1739 1740 1741 1742
out_free_idr:
	idr_remove(&zram_index_idr, device_id);
out_free_dev:
	kfree(zram);
1743
	return ret;
1744 1745
}

1746
static int zram_remove(struct zram *zram)
1747
{
1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763
	struct block_device *bdev;

	bdev = bdget_disk(zram->disk, 0);
	if (!bdev)
		return -ENOMEM;

	mutex_lock(&bdev->bd_mutex);
	if (bdev->bd_openers || zram->claim) {
		mutex_unlock(&bdev->bd_mutex);
		bdput(bdev);
		return -EBUSY;
	}

	zram->claim = true;
	mutex_unlock(&bdev->bd_mutex);

1764
	zram_debugfs_unregister(zram);
1765 1766
	/*
	 * Remove sysfs first, so no one will perform a disksize
1767 1768 1769 1770
	 * store while we destroy the devices. This also helps during
	 * hot_remove -- zram_reset_device() is the last holder of
	 * ->init_lock, no later/concurrent disksize_store() or any
	 * other sysfs handlers are possible.
1771 1772 1773
	 */
	sysfs_remove_group(&disk_to_dev(zram->disk)->kobj,
			&zram_disk_attr_group);
1774

1775 1776
	/* Make sure all the pending I/O are finished */
	fsync_bdev(bdev);
1777
	zram_reset_device(zram);
1778 1779 1780 1781
	bdput(bdev);

	pr_info("Removed device: %s\n", zram->disk->disk_name);

1782
	del_gendisk(zram->disk);
1783
	blk_cleanup_queue(zram->disk->queue);
1784 1785
	put_disk(zram->disk);
	kfree(zram);
1786 1787 1788 1789
	return 0;
}

/* zram-control sysfs attributes */
1790 1791 1792 1793 1794 1795 1796

/*
 * NOTE: hot_add attribute is not the usual read-only sysfs attribute. In a
 * sense that reading from this file does alter the state of your system -- it
 * creates a new un-initialized zram device and returns back this device's
 * device_id (or an error code if it fails to create a new device).
 */
1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810
static ssize_t hot_add_show(struct class *class,
			struct class_attribute *attr,
			char *buf)
{
	int ret;

	mutex_lock(&zram_index_mutex);
	ret = zram_add();
	mutex_unlock(&zram_index_mutex);

	if (ret < 0)
		return ret;
	return scnprintf(buf, PAGE_SIZE, "%d\n", ret);
}
1811
static CLASS_ATTR_RO(hot_add);
1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830

static ssize_t hot_remove_store(struct class *class,
			struct class_attribute *attr,
			const char *buf,
			size_t count)
{
	struct zram *zram;
	int ret, dev_id;

	/* dev_id is gendisk->first_minor, which is `int' */
	ret = kstrtoint(buf, 10, &dev_id);
	if (ret)
		return ret;
	if (dev_id < 0)
		return -EINVAL;

	mutex_lock(&zram_index_mutex);

	zram = idr_find(&zram_index_idr, dev_id);
1831
	if (zram) {
1832
		ret = zram_remove(zram);
1833 1834
		if (!ret)
			idr_remove(&zram_index_idr, dev_id);
1835
	} else {
1836
		ret = -ENODEV;
1837
	}
1838 1839 1840

	mutex_unlock(&zram_index_mutex);
	return ret ? ret : count;
1841
}
1842
static CLASS_ATTR_WO(hot_remove);
1843

1844 1845 1846 1847
static struct attribute *zram_control_class_attrs[] = {
	&class_attr_hot_add.attr,
	&class_attr_hot_remove.attr,
	NULL,
1848
};
1849
ATTRIBUTE_GROUPS(zram_control_class);
1850 1851 1852 1853

static struct class zram_control_class = {
	.name		= "zram-control",
	.owner		= THIS_MODULE,
1854
	.class_groups	= zram_control_class_groups,
1855 1856
};

1857 1858 1859 1860 1861
static int zram_remove_cb(int id, void *ptr, void *data)
{
	zram_remove(ptr);
	return 0;
}
1862

1863 1864
static void destroy_devices(void)
{
1865
	class_unregister(&zram_control_class);
1866
	idr_for_each(&zram_index_idr, &zram_remove_cb, NULL);
1867
	zram_debugfs_destroy();
1868
	idr_destroy(&zram_index_idr);
1869
	unregister_blkdev(zram_major, "zram");
1870
	cpuhp_remove_multi_state(CPUHP_ZCOMP_PREPARE);
1871 1872
}

1873
static int __init zram_init(void)
1874
{
1875
	int ret;
1876

1877 1878 1879 1880 1881
	ret = cpuhp_setup_state_multi(CPUHP_ZCOMP_PREPARE, "block/zram:prepare",
				      zcomp_cpu_up_prepare, zcomp_cpu_dead);
	if (ret < 0)
		return ret;

1882 1883
	ret = class_register(&zram_control_class);
	if (ret) {
S
Sergey Senozhatsky 已提交
1884
		pr_err("Unable to register zram-control class\n");
1885
		cpuhp_remove_multi_state(CPUHP_ZCOMP_PREPARE);
1886 1887 1888
		return ret;
	}

1889
	zram_debugfs_create();
1890 1891
	zram_major = register_blkdev(0, "zram");
	if (zram_major <= 0) {
S
Sergey Senozhatsky 已提交
1892
		pr_err("Unable to get major number\n");
1893
		class_unregister(&zram_control_class);
1894
		cpuhp_remove_multi_state(CPUHP_ZCOMP_PREPARE);
1895
		return -EBUSY;
1896 1897
	}

1898
	while (num_devices != 0) {
1899
		mutex_lock(&zram_index_mutex);
1900
		ret = zram_add();
1901
		mutex_unlock(&zram_index_mutex);
1902
		if (ret < 0)
1903
			goto out_error;
1904
		num_devices--;
1905 1906
	}

1907
	return 0;
1908

1909
out_error:
1910
	destroy_devices();
1911 1912 1913
	return ret;
}

1914
static void __exit zram_exit(void)
1915
{
1916
	destroy_devices();
1917 1918
}

1919 1920
module_init(zram_init);
module_exit(zram_exit);
1921

1922
module_param(num_devices, uint, 0);
1923
MODULE_PARM_DESC(num_devices, "Number of pre-created zram devices");
1924

1925 1926
MODULE_LICENSE("Dual BSD/GPL");
MODULE_AUTHOR("Nitin Gupta <ngupta@vflare.org>");
1927
MODULE_DESCRIPTION("Compressed RAM Block Device");