12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274 |
- /*
- * Compressed RAM block device
- *
- * Copyright (C) 2008, 2009, 2010 Nitin Gupta
- * 2012, 2013 Minchan Kim
- *
- * 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
- *
- */
- #define KMSG_COMPONENT "zram"
- #define pr_fmt(fmt) KMSG_COMPONENT ": " fmt
- #include <linux/module.h>
- #include <linux/kernel.h>
- #include <linux/bio.h>
- #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>
- #include <linux/slab.h>
- #include <linux/string.h>
- #include <linux/vmalloc.h>
- #include <linux/err.h>
- #include "zram_drv.h"
- /* Globals */
- static int zram_major;
- static struct zram *zram_devices;
- static const char *default_compressor = "lzo";
- /* Module params (documentation at end) */
- static unsigned int num_devices = 1;
- static inline void deprecated_attr_warn(const char *name)
- {
- pr_warn_once("%d (%s) Attribute %s (and others) will be removed. %s\n",
- task_pid_nr(current),
- current->comm,
- name,
- "See zram documentation.");
- }
- #define ZRAM_ATTR_RO(name) \
- static ssize_t zram_attr_##name##_show(struct device *d, \
- struct device_attribute *attr, char *b) \
- { \
- struct zram *zram = dev_to_zram(d); \
- \
- deprecated_attr_warn(__stringify(name)); \
- return scnprintf(b, PAGE_SIZE, "%llu\n", \
- (u64)atomic64_read(&zram->stats.name)); \
- } \
- static struct device_attribute dev_attr_##name = \
- __ATTR(name, S_IRUGO, zram_attr_##name##_show, NULL);
- static inline bool init_done(struct zram *zram)
- {
- return zram->disksize;
- }
- static inline struct zram *dev_to_zram(struct device *dev)
- {
- return (struct zram *)dev_to_disk(dev)->private_data;
- }
- static ssize_t compact_store(struct device *dev,
- struct device_attribute *attr, const char *buf, size_t len)
- {
- unsigned long nr_migrated;
- struct zram *zram = dev_to_zram(dev);
- struct zram_meta *meta;
- down_read(&zram->init_lock);
- if (!init_done(zram)) {
- up_read(&zram->init_lock);
- return -EINVAL;
- }
- meta = zram->meta;
- nr_migrated = zs_compact(meta->mem_pool);
- atomic64_add(nr_migrated, &zram->stats.num_migrated);
- up_read(&zram->init_lock);
- return len;
- }
- 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);
- }
- static ssize_t initstate_show(struct device *dev,
- struct device_attribute *attr, char *buf)
- {
- u32 val;
- struct zram *zram = dev_to_zram(dev);
- down_read(&zram->init_lock);
- val = init_done(zram);
- up_read(&zram->init_lock);
- return scnprintf(buf, PAGE_SIZE, "%u\n", val);
- }
- static ssize_t orig_data_size_show(struct device *dev,
- struct device_attribute *attr, char *buf)
- {
- struct zram *zram = dev_to_zram(dev);
- deprecated_attr_warn("orig_data_size");
- return scnprintf(buf, PAGE_SIZE, "%llu\n",
- (u64)(atomic64_read(&zram->stats.pages_stored)) << PAGE_SHIFT);
- }
- static ssize_t mem_used_total_show(struct device *dev,
- struct device_attribute *attr, char *buf)
- {
- u64 val = 0;
- struct zram *zram = dev_to_zram(dev);
- deprecated_attr_warn("mem_used_total");
- down_read(&zram->init_lock);
- if (init_done(zram)) {
- struct zram_meta *meta = zram->meta;
- val = zs_get_total_pages(meta->mem_pool);
- }
- up_read(&zram->init_lock);
- return scnprintf(buf, PAGE_SIZE, "%llu\n", val << PAGE_SHIFT);
- }
- static ssize_t max_comp_streams_show(struct device *dev,
- struct device_attribute *attr, char *buf)
- {
- int val;
- struct zram *zram = dev_to_zram(dev);
- down_read(&zram->init_lock);
- val = zram->max_comp_streams;
- up_read(&zram->init_lock);
- return scnprintf(buf, PAGE_SIZE, "%d\n", val);
- }
- static ssize_t mem_limit_show(struct device *dev,
- struct device_attribute *attr, char *buf)
- {
- u64 val;
- struct zram *zram = dev_to_zram(dev);
- deprecated_attr_warn("mem_limit");
- down_read(&zram->init_lock);
- val = zram->limit_pages;
- up_read(&zram->init_lock);
- return scnprintf(buf, PAGE_SIZE, "%llu\n", val << PAGE_SHIFT);
- }
- 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;
- }
- static ssize_t mem_used_max_show(struct device *dev,
- struct device_attribute *attr, char *buf)
- {
- u64 val = 0;
- struct zram *zram = dev_to_zram(dev);
- deprecated_attr_warn("mem_used_max");
- down_read(&zram->init_lock);
- if (init_done(zram))
- val = atomic_long_read(&zram->stats.max_used_pages);
- up_read(&zram->init_lock);
- return scnprintf(buf, PAGE_SIZE, "%llu\n", val << PAGE_SHIFT);
- }
- 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);
- if (init_done(zram)) {
- struct zram_meta *meta = zram->meta;
- atomic_long_set(&zram->stats.max_used_pages,
- zs_get_total_pages(meta->mem_pool));
- }
- up_read(&zram->init_lock);
- return len;
- }
- static ssize_t max_comp_streams_store(struct device *dev,
- struct device_attribute *attr, const char *buf, size_t len)
- {
- int num;
- struct zram *zram = dev_to_zram(dev);
- int ret;
- ret = kstrtoint(buf, 0, &num);
- if (ret < 0)
- return ret;
- if (num < 1)
- return -EINVAL;
- down_write(&zram->init_lock);
- if (init_done(zram)) {
- if (!zcomp_set_max_streams(zram->comp, num)) {
- pr_info("Cannot change max compression streams\n");
- ret = -EINVAL;
- goto out;
- }
- }
- zram->max_comp_streams = num;
- ret = len;
- out:
- up_write(&zram->init_lock);
- return ret;
- }
- 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);
- 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;
- }
- strlcpy(zram->compressor, buf, sizeof(zram->compressor));
- up_write(&zram->init_lock);
- return len;
- }
- /* flag operations needs meta->tb_lock */
- static int zram_test_flag(struct zram_meta *meta, u32 index,
- enum zram_pageflags flag)
- {
- return meta->table[index].value & BIT(flag);
- }
- static void zram_set_flag(struct zram_meta *meta, u32 index,
- enum zram_pageflags flag)
- {
- meta->table[index].value |= BIT(flag);
- }
- static void zram_clear_flag(struct zram_meta *meta, u32 index,
- enum zram_pageflags flag)
- {
- meta->table[index].value &= ~BIT(flag);
- }
- static size_t zram_get_obj_size(struct zram_meta *meta, u32 index)
- {
- return meta->table[index].value & (BIT(ZRAM_FLAG_SHIFT) - 1);
- }
- static void zram_set_obj_size(struct zram_meta *meta,
- u32 index, size_t size)
- {
- unsigned long flags = meta->table[index].value >> ZRAM_FLAG_SHIFT;
- meta->table[index].value = (flags << ZRAM_FLAG_SHIFT) | size;
- }
- static inline int is_partial_io(struct bio_vec *bvec)
- {
- return bvec->bv_len != PAGE_SIZE;
- }
- /*
- * Check if request is within bounds and aligned on zram logical blocks.
- */
- static inline int valid_io_request(struct zram *zram,
- sector_t start, unsigned int size)
- {
- u64 end, bound;
- /* unaligned request */
- if (unlikely(start & (ZRAM_SECTOR_PER_LOGICAL_BLOCK - 1)))
- return 0;
- if (unlikely(size & (ZRAM_LOGICAL_BLOCK_SIZE - 1)))
- return 0;
- end = start + (size >> SECTOR_SHIFT);
- bound = zram->disksize >> SECTOR_SHIFT;
- /* out of range range */
- if (unlikely(start >= bound || end > bound || start > end))
- return 0;
- /* I/O request is valid */
- return 1;
- }
- static void zram_meta_free(struct zram_meta *meta, u64 disksize)
- {
- size_t num_pages = disksize >> PAGE_SHIFT;
- size_t index;
- /* Free all pages that are still in this zram device */
- for (index = 0; index < num_pages; index++) {
- unsigned long handle = meta->table[index].handle;
- if (!handle)
- continue;
- zs_free(meta->mem_pool, handle);
- }
- zs_destroy_pool(meta->mem_pool);
- vfree(meta->table);
- kfree(meta);
- }
- static struct zram_meta *zram_meta_alloc(int device_id, u64 disksize)
- {
- size_t num_pages;
- char pool_name[8];
- struct zram_meta *meta = kmalloc(sizeof(*meta), GFP_KERNEL);
- if (!meta)
- return NULL;
- num_pages = disksize >> PAGE_SHIFT;
- meta->table = vzalloc(num_pages * sizeof(*meta->table));
- if (!meta->table) {
- pr_err("Error allocating zram address table\n");
- goto out_error;
- }
- snprintf(pool_name, sizeof(pool_name), "zram%d", device_id);
- meta->mem_pool = zs_create_pool(pool_name, GFP_NOIO | __GFP_HIGHMEM);
- if (!meta->mem_pool) {
- pr_err("Error creating memory pool\n");
- goto out_error;
- }
- return meta;
- out_error:
- vfree(meta->table);
- kfree(meta);
- return NULL;
- }
- static inline bool zram_meta_get(struct zram *zram)
- {
- if (atomic_inc_not_zero(&zram->refcount))
- return true;
- return false;
- }
- static inline void zram_meta_put(struct zram *zram)
- {
- atomic_dec(&zram->refcount);
- }
- static void update_position(u32 *index, int *offset, struct bio_vec *bvec)
- {
- if (*offset + bvec->bv_len >= PAGE_SIZE)
- (*index)++;
- *offset = (*offset + bvec->bv_len) % PAGE_SIZE;
- }
- static int page_zero_filled(void *ptr)
- {
- unsigned int pos;
- unsigned long *page;
- page = (unsigned long *)ptr;
- for (pos = 0; pos != PAGE_SIZE / sizeof(*page); pos++) {
- if (page[pos])
- return 0;
- }
- return 1;
- }
- static void handle_zero_page(struct bio_vec *bvec)
- {
- struct page *page = bvec->bv_page;
- void *user_mem;
- user_mem = kmap_atomic(page);
- if (is_partial_io(bvec))
- memset(user_mem + bvec->bv_offset, 0, bvec->bv_len);
- else
- clear_page(user_mem);
- kunmap_atomic(user_mem);
- flush_dcache_page(page);
- }
- /*
- * 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.
- */
- static void zram_free_page(struct zram *zram, size_t index)
- {
- struct zram_meta *meta = zram->meta;
- unsigned long handle = meta->table[index].handle;
- if (unlikely(!handle)) {
- /*
- * No memory is allocated for zero filled pages.
- * Simply clear zero page flag.
- */
- if (zram_test_flag(meta, index, ZRAM_ZERO)) {
- zram_clear_flag(meta, index, ZRAM_ZERO);
- atomic64_dec(&zram->stats.zero_pages);
- }
- return;
- }
- zs_free(meta->mem_pool, handle);
- atomic64_sub(zram_get_obj_size(meta, index),
- &zram->stats.compr_data_size);
- atomic64_dec(&zram->stats.pages_stored);
- meta->table[index].handle = 0;
- zram_set_obj_size(meta, index, 0);
- }
- static int zram_decompress_page(struct zram *zram, char *mem, u32 index)
- {
- int ret = 0;
- unsigned char *cmem;
- struct zram_meta *meta = zram->meta;
- unsigned long handle;
- size_t size;
- bit_spin_lock(ZRAM_ACCESS, &meta->table[index].value);
- handle = meta->table[index].handle;
- size = zram_get_obj_size(meta, index);
- if (!handle || zram_test_flag(meta, index, ZRAM_ZERO)) {
- bit_spin_unlock(ZRAM_ACCESS, &meta->table[index].value);
- memset(mem, 0, PAGE_SIZE);
- return 0;
- }
- cmem = zs_map_object(meta->mem_pool, handle, ZS_MM_RO);
- if (size == PAGE_SIZE)
- memcpy(mem, cmem, PAGE_SIZE);
- else
- ret = zcomp_decompress(zram->comp, cmem, size, mem);
- zs_unmap_object(meta->mem_pool, handle);
- bit_spin_unlock(ZRAM_ACCESS, &meta->table[index].value);
- /* Should NEVER happen. Return bio error if it does. */
- if (unlikely(ret)) {
- pr_err("Decompression failed! err=%d, page=%u\n", ret, index);
- return ret;
- }
- return 0;
- }
- static int zram_bvec_read(struct zram *zram, struct bio_vec *bvec,
- u32 index, int offset)
- {
- int ret;
- struct page *page;
- unsigned char *user_mem, *uncmem = NULL;
- struct zram_meta *meta = zram->meta;
- page = bvec->bv_page;
- bit_spin_lock(ZRAM_ACCESS, &meta->table[index].value);
- if (unlikely(!meta->table[index].handle) ||
- zram_test_flag(meta, index, ZRAM_ZERO)) {
- bit_spin_unlock(ZRAM_ACCESS, &meta->table[index].value);
- handle_zero_page(bvec);
- return 0;
- }
- bit_spin_unlock(ZRAM_ACCESS, &meta->table[index].value);
- if (is_partial_io(bvec))
- /* Use a temporary buffer to decompress the page */
- uncmem = kmalloc(PAGE_SIZE, GFP_NOIO);
- user_mem = kmap_atomic(page);
- if (!is_partial_io(bvec))
- uncmem = user_mem;
- if (!uncmem) {
- pr_info("Unable to allocate temp memory\n");
- ret = -ENOMEM;
- goto out_cleanup;
- }
- ret = zram_decompress_page(zram, uncmem, index);
- /* Should NEVER happen. Return bio error if it does. */
- if (unlikely(ret))
- goto out_cleanup;
- if (is_partial_io(bvec))
- memcpy(user_mem + bvec->bv_offset, uncmem + offset,
- bvec->bv_len);
- flush_dcache_page(page);
- ret = 0;
- out_cleanup:
- kunmap_atomic(user_mem);
- if (is_partial_io(bvec))
- kfree(uncmem);
- return ret;
- }
- 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);
- }
- static int zram_bvec_write(struct zram *zram, struct bio_vec *bvec, u32 index,
- int offset)
- {
- int ret = 0;
- size_t clen;
- unsigned long handle;
- struct page *page;
- unsigned char *user_mem, *cmem, *src, *uncmem = NULL;
- struct zram_meta *meta = zram->meta;
- struct zcomp_strm *zstrm;
- bool locked = false;
- unsigned long alloced_pages;
- page = bvec->bv_page;
- if (is_partial_io(bvec)) {
- /*
- * This is a partial IO. We need to read the full page
- * before to write the changes.
- */
- uncmem = kmalloc(PAGE_SIZE, GFP_NOIO);
- if (!uncmem) {
- ret = -ENOMEM;
- goto out;
- }
- ret = zram_decompress_page(zram, uncmem, index);
- if (ret)
- goto out;
- }
- zstrm = zcomp_strm_find(zram->comp);
- locked = true;
- user_mem = kmap_atomic(page);
- if (is_partial_io(bvec)) {
- memcpy(uncmem + offset, user_mem + bvec->bv_offset,
- bvec->bv_len);
- kunmap_atomic(user_mem);
- user_mem = NULL;
- } else {
- uncmem = user_mem;
- }
- if (page_zero_filled(uncmem)) {
- if (user_mem)
- kunmap_atomic(user_mem);
- /* Free memory associated with this sector now. */
- bit_spin_lock(ZRAM_ACCESS, &meta->table[index].value);
- zram_free_page(zram, index);
- zram_set_flag(meta, index, ZRAM_ZERO);
- bit_spin_unlock(ZRAM_ACCESS, &meta->table[index].value);
- atomic64_inc(&zram->stats.zero_pages);
- ret = 0;
- goto out;
- }
- ret = zcomp_compress(zram->comp, zstrm, uncmem, &clen);
- if (!is_partial_io(bvec)) {
- kunmap_atomic(user_mem);
- user_mem = NULL;
- uncmem = NULL;
- }
- if (unlikely(ret)) {
- pr_err("Compression failed! err=%d\n", ret);
- goto out;
- }
- src = zstrm->buffer;
- if (unlikely(clen > max_zpage_size)) {
- clen = PAGE_SIZE;
- if (is_partial_io(bvec))
- src = uncmem;
- }
- handle = zs_malloc(meta->mem_pool, clen);
- if (!handle) {
- pr_info("Error allocating memory for compressed page: %u, size=%zu\n",
- index, clen);
- ret = -ENOMEM;
- goto out;
- }
- alloced_pages = zs_get_total_pages(meta->mem_pool);
- if (zram->limit_pages && alloced_pages > zram->limit_pages) {
- zs_free(meta->mem_pool, handle);
- ret = -ENOMEM;
- goto out;
- }
- update_used_max(zram, alloced_pages);
- cmem = zs_map_object(meta->mem_pool, handle, ZS_MM_WO);
- if ((clen == PAGE_SIZE) && !is_partial_io(bvec)) {
- src = kmap_atomic(page);
- memcpy(cmem, src, PAGE_SIZE);
- kunmap_atomic(src);
- } else {
- memcpy(cmem, src, clen);
- }
- zcomp_strm_release(zram->comp, zstrm);
- locked = false;
- zs_unmap_object(meta->mem_pool, handle);
- /*
- * Free memory associated with this sector
- * before overwriting unused sectors.
- */
- bit_spin_lock(ZRAM_ACCESS, &meta->table[index].value);
- zram_free_page(zram, index);
- meta->table[index].handle = handle;
- zram_set_obj_size(meta, index, clen);
- bit_spin_unlock(ZRAM_ACCESS, &meta->table[index].value);
- /* Update stats */
- atomic64_add(clen, &zram->stats.compr_data_size);
- atomic64_inc(&zram->stats.pages_stored);
- out:
- if (locked)
- zcomp_strm_release(zram->comp, zstrm);
- if (is_partial_io(bvec))
- kfree(uncmem);
- return ret;
- }
- static int zram_bvec_rw(struct zram *zram, struct bio_vec *bvec, u32 index,
- int offset, int rw)
- {
- int ret;
- if (rw == READ) {
- atomic64_inc(&zram->stats.num_reads);
- ret = zram_bvec_read(zram, bvec, index, offset);
- } else {
- atomic64_inc(&zram->stats.num_writes);
- ret = zram_bvec_write(zram, bvec, index, offset);
- }
- if (unlikely(ret)) {
- if (rw == READ)
- atomic64_inc(&zram->stats.failed_reads);
- else
- atomic64_inc(&zram->stats.failed_writes);
- }
- return ret;
- }
- /*
- * 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_size;
- struct zram_meta *meta = zram->meta;
- /*
- * 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) {
- if (n <= (PAGE_SIZE - offset))
- return;
- n -= (PAGE_SIZE - offset);
- index++;
- }
- while (n >= PAGE_SIZE) {
- bit_spin_lock(ZRAM_ACCESS, &meta->table[index].value);
- zram_free_page(zram, index);
- bit_spin_unlock(ZRAM_ACCESS, &meta->table[index].value);
- atomic64_inc(&zram->stats.notify_free);
- index++;
- n -= PAGE_SIZE;
- }
- }
- static void zram_reset_device(struct zram *zram)
- {
- struct zram_meta *meta;
- struct zcomp *comp;
- u64 disksize;
- down_write(&zram->init_lock);
- zram->limit_pages = 0;
- if (!init_done(zram)) {
- up_write(&zram->init_lock);
- return;
- }
- meta = zram->meta;
- comp = zram->comp;
- disksize = zram->disksize;
- /*
- * Refcount will go down to 0 eventually and r/w handler
- * cannot handle further I/O so it will bail out by
- * check zram_meta_get.
- */
- zram_meta_put(zram);
- /*
- * We want to free zram_meta in process context to avoid
- * deadlock between reclaim path and any other locks.
- */
- wait_event(zram->io_done, atomic_read(&zram->refcount) == 0);
- /* Reset stats */
- memset(&zram->stats, 0, sizeof(zram->stats));
- zram->disksize = 0;
- zram->max_comp_streams = 1;
- 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 */
- zram_meta_free(meta, disksize);
- zcomp_destroy(comp);
- }
- static ssize_t disksize_store(struct device *dev,
- struct device_attribute *attr, const char *buf, size_t len)
- {
- u64 disksize;
- struct zcomp *comp;
- struct zram_meta *meta;
- struct zram *zram = dev_to_zram(dev);
- int err;
- disksize = memparse(buf, NULL);
- if (!disksize)
- return -EINVAL;
- disksize = PAGE_ALIGN(disksize);
- meta = zram_meta_alloc(zram->disk->first_minor, disksize);
- if (!meta)
- return -ENOMEM;
- comp = zcomp_create(zram->compressor, zram->max_comp_streams);
- if (IS_ERR(comp)) {
- pr_info("Cannot initialise %s compressing backend\n",
- zram->compressor);
- err = PTR_ERR(comp);
- goto out_free_meta;
- }
- down_write(&zram->init_lock);
- if (init_done(zram)) {
- pr_info("Cannot change disksize for initialized device\n");
- err = -EBUSY;
- goto out_destroy_comp;
- }
- init_waitqueue_head(&zram->io_done);
- atomic_set(&zram->refcount, 1);
- zram->meta = meta;
- zram->comp = comp;
- zram->disksize = disksize;
- set_capacity(zram->disk, zram->disksize >> SECTOR_SHIFT);
- up_write(&zram->init_lock);
- /*
- * Revalidate disk out of the init_lock to avoid lockdep splat.
- * It's okay because disk's capacity is protected by init_lock
- * so that revalidate_disk always sees up-to-date capacity.
- */
- revalidate_disk(zram->disk);
- return len;
- out_destroy_comp:
- up_write(&zram->init_lock);
- zcomp_destroy(comp);
- out_free_meta:
- zram_meta_free(meta, disksize);
- return err;
- }
- static ssize_t reset_store(struct device *dev,
- struct device_attribute *attr, const char *buf, size_t len)
- {
- int ret;
- unsigned short do_reset;
- struct zram *zram;
- struct block_device *bdev;
- zram = dev_to_zram(dev);
- bdev = bdget_disk(zram->disk, 0);
- if (!bdev)
- return -ENOMEM;
- mutex_lock(&bdev->bd_mutex);
- /* Do not reset an active device! */
- if (bdev->bd_openers) {
- ret = -EBUSY;
- goto out;
- }
- ret = kstrtou16(buf, 10, &do_reset);
- if (ret)
- goto out;
- if (!do_reset) {
- ret = -EINVAL;
- goto out;
- }
- /* Make sure all pending I/O is finished */
- fsync_bdev(bdev);
- zram_reset_device(zram);
- mutex_unlock(&bdev->bd_mutex);
- revalidate_disk(zram->disk);
- bdput(bdev);
- return len;
- out:
- mutex_unlock(&bdev->bd_mutex);
- bdput(bdev);
- return ret;
- }
- static void __zram_make_request(struct zram *zram, struct bio *bio)
- {
- int i, offset, rw;
- u32 index;
- struct bio_vec *bvec;
- index = bio->bi_sector >> SECTORS_PER_PAGE_SHIFT;
- offset = (bio->bi_sector & (SECTORS_PER_PAGE - 1)) << SECTOR_SHIFT;
- if (unlikely(bio->bi_rw & REQ_DISCARD)) {
- zram_bio_discard(zram, index, offset, bio);
- bio_endio(bio, 0);
- return;
- }
- rw = bio_data_dir(bio);
- bio_for_each_segment(bvec, bio, i) {
- int max_transfer_size = PAGE_SIZE - offset;
- if (bvec->bv_len > max_transfer_size) {
- /*
- * zram_bvec_rw() can only make operation on a single
- * zram page. Split the bio vector.
- */
- struct bio_vec bv;
- bv.bv_page = bvec->bv_page;
- bv.bv_len = max_transfer_size;
- bv.bv_offset = bvec->bv_offset;
- if (zram_bvec_rw(zram, &bv, index, offset, rw) < 0)
- goto out;
- bv.bv_len = bvec->bv_len - max_transfer_size;
- bv.bv_offset += max_transfer_size;
- if (zram_bvec_rw(zram, &bv, index + 1, 0, rw) < 0)
- goto out;
- } else
- if (zram_bvec_rw(zram, bvec, index, offset, rw) < 0)
- goto out;
- update_position(&index, &offset, bvec);
- }
- set_bit(BIO_UPTODATE, &bio->bi_flags);
- bio_endio(bio, 0);
- return;
- out:
- bio_io_error(bio);
- }
- /*
- * Handler function for all zram I/O requests.
- */
- static void zram_make_request(struct request_queue *queue, struct bio *bio)
- {
- struct zram *zram = queue->queuedata;
- if (unlikely(!zram_meta_get(zram)))
- goto error;
- if (!valid_io_request(zram, bio->bi_sector,
- bio->bi_size)) {
- atomic64_inc(&zram->stats.invalid_io);
- goto put_zram;
- }
- __zram_make_request(zram, bio);
- zram_meta_put(zram);
- return;
- put_zram:
- zram_meta_put(zram);
- error:
- bio_io_error(bio);
- }
- static void zram_slot_free_notify(struct block_device *bdev,
- unsigned long index)
- {
- struct zram *zram;
- struct zram_meta *meta;
- zram = bdev->bd_disk->private_data;
- meta = zram->meta;
- bit_spin_lock(ZRAM_ACCESS, &meta->table[index].value);
- zram_free_page(zram, index);
- bit_spin_unlock(ZRAM_ACCESS, &meta->table[index].value);
- atomic64_inc(&zram->stats.notify_free);
- }
- static const struct block_device_operations zram_devops = {
- .swap_slot_free_notify = zram_slot_free_notify,
- .owner = THIS_MODULE
- };
- static DEVICE_ATTR(compact, S_IWUSR, NULL, compact_store);
- static DEVICE_ATTR(disksize, S_IRUGO | S_IWUSR,
- disksize_show, disksize_store);
- static DEVICE_ATTR(initstate, S_IRUGO, initstate_show, NULL);
- static DEVICE_ATTR(reset, S_IWUSR, NULL, reset_store);
- static DEVICE_ATTR(orig_data_size, S_IRUGO, orig_data_size_show, NULL);
- static DEVICE_ATTR(mem_used_total, S_IRUGO, mem_used_total_show, NULL);
- static DEVICE_ATTR(mem_limit, S_IRUGO | S_IWUSR, mem_limit_show,
- mem_limit_store);
- static DEVICE_ATTR(mem_used_max, S_IRUGO | S_IWUSR, mem_used_max_show,
- mem_used_max_store);
- static DEVICE_ATTR(max_comp_streams, S_IRUGO | S_IWUSR,
- max_comp_streams_show, max_comp_streams_store);
- static DEVICE_ATTR(comp_algorithm, S_IRUGO | S_IWUSR,
- comp_algorithm_show, comp_algorithm_store);
- static ssize_t io_stat_show(struct device *dev,
- struct device_attribute *attr, char *buf)
- {
- struct zram *zram = dev_to_zram(dev);
- ssize_t ret;
- 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);
- return ret;
- }
- static ssize_t mm_stat_show(struct device *dev,
- struct device_attribute *attr, char *buf)
- {
- struct zram *zram = dev_to_zram(dev);
- u64 orig_size, mem_used = 0;
- long max_used;
- ssize_t ret;
- down_read(&zram->init_lock);
- if (init_done(zram))
- mem_used = zs_get_total_pages(zram->meta->mem_pool);
- orig_size = atomic64_read(&zram->stats.pages_stored);
- max_used = atomic_long_read(&zram->stats.max_used_pages);
- ret = scnprintf(buf, PAGE_SIZE,
- "%8llu %8llu %8llu %8lu %8ld %8llu %8llu\n",
- 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,
- (u64)atomic64_read(&zram->stats.zero_pages),
- (u64)atomic64_read(&zram->stats.num_migrated));
- up_read(&zram->init_lock);
- return ret;
- }
- static DEVICE_ATTR(io_stat, S_IRUGO, io_stat_show, NULL);
- static DEVICE_ATTR(mm_stat, S_IRUGO, mm_stat_show, NULL);
- ZRAM_ATTR_RO(num_reads);
- ZRAM_ATTR_RO(num_writes);
- ZRAM_ATTR_RO(failed_reads);
- ZRAM_ATTR_RO(failed_writes);
- ZRAM_ATTR_RO(invalid_io);
- ZRAM_ATTR_RO(notify_free);
- ZRAM_ATTR_RO(zero_pages);
- ZRAM_ATTR_RO(compr_data_size);
- static struct attribute *zram_disk_attrs[] = {
- &dev_attr_disksize.attr,
- &dev_attr_initstate.attr,
- &dev_attr_reset.attr,
- &dev_attr_num_reads.attr,
- &dev_attr_num_writes.attr,
- &dev_attr_failed_reads.attr,
- &dev_attr_failed_writes.attr,
- &dev_attr_compact.attr,
- &dev_attr_invalid_io.attr,
- &dev_attr_notify_free.attr,
- &dev_attr_zero_pages.attr,
- &dev_attr_orig_data_size.attr,
- &dev_attr_compr_data_size.attr,
- &dev_attr_mem_used_total.attr,
- &dev_attr_mem_limit.attr,
- &dev_attr_mem_used_max.attr,
- &dev_attr_max_comp_streams.attr,
- &dev_attr_comp_algorithm.attr,
- &dev_attr_io_stat.attr,
- &dev_attr_mm_stat.attr,
- NULL,
- };
- static struct attribute_group zram_disk_attr_group = {
- .attrs = zram_disk_attrs,
- };
- static int create_device(struct zram *zram, int device_id)
- {
- struct request_queue *queue;
- int ret = -ENOMEM;
- init_rwsem(&zram->init_lock);
- queue = blk_alloc_queue(GFP_KERNEL);
- if (!queue) {
- pr_err("Error allocating disk queue for device %d\n",
- device_id);
- goto out;
- }
- blk_queue_make_request(queue, zram_make_request);
- /* gendisk structure */
- zram->disk = alloc_disk(1);
- if (!zram->disk) {
- pr_warn("Error allocating disk structure for device %d\n",
- device_id);
- ret = -ENOMEM;
- goto out_free_queue;
- }
- zram->disk->major = zram_major;
- zram->disk->first_minor = device_id;
- zram->disk->fops = &zram_devops;
- zram->disk->queue = queue;
- zram->disk->queue->queuedata = zram;
- zram->disk->private_data = zram;
- snprintf(zram->disk->disk_name, 16, "zram%d", device_id);
- /* Actual capacity set using syfs (/sys/block/zram<id>/disksize */
- set_capacity(zram->disk, 0);
- /* zram devices sort of resembles non-rotational disks */
- queue_flag_set_unlocked(QUEUE_FLAG_NONROT, zram->disk->queue);
- queue_flag_clear_unlocked(QUEUE_FLAG_ADD_RANDOM, zram->disk->queue);
- /*
- * To ensure that we always get PAGE_SIZE aligned
- * and n*PAGE_SIZED sized I/O requests.
- */
- blk_queue_physical_block_size(zram->disk->queue, PAGE_SIZE);
- blk_queue_logical_block_size(zram->disk->queue,
- ZRAM_LOGICAL_BLOCK_SIZE);
- blk_queue_io_min(zram->disk->queue, PAGE_SIZE);
- blk_queue_io_opt(zram->disk->queue, PAGE_SIZE);
- zram->disk->queue->limits.discard_granularity = PAGE_SIZE;
- zram->disk->queue->limits.max_discard_sectors = UINT_MAX;
- /*
- * 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)
- zram->disk->queue->limits.discard_zeroes_data = 1;
- else
- zram->disk->queue->limits.discard_zeroes_data = 0;
- queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, zram->disk->queue);
- add_disk(zram->disk);
- ret = sysfs_create_group(&disk_to_dev(zram->disk)->kobj,
- &zram_disk_attr_group);
- if (ret < 0) {
- pr_warn("Error creating sysfs group");
- goto out_free_disk;
- }
- strlcpy(zram->compressor, default_compressor, sizeof(zram->compressor));
- zram->meta = NULL;
- zram->max_comp_streams = 1;
- return 0;
- out_free_disk:
- del_gendisk(zram->disk);
- put_disk(zram->disk);
- out_free_queue:
- blk_cleanup_queue(queue);
- out:
- return ret;
- }
- static void destroy_devices(unsigned int nr)
- {
- struct zram *zram;
- unsigned int i;
- for (i = 0; i < nr; i++) {
- zram = &zram_devices[i];
- /*
- * Remove sysfs first, so no one will perform a disksize
- * store while we destroy the devices
- */
- sysfs_remove_group(&disk_to_dev(zram->disk)->kobj,
- &zram_disk_attr_group);
- zram_reset_device(zram);
- blk_cleanup_queue(zram->disk->queue);
- del_gendisk(zram->disk);
- put_disk(zram->disk);
- }
- kfree(zram_devices);
- unregister_blkdev(zram_major, "zram");
- pr_info("Destroyed %u device(s)\n", nr);
- }
- static int __init zram_init(void)
- {
- int ret, dev_id;
- if (num_devices > max_num_devices) {
- pr_warn("Invalid value for num_devices: %u\n",
- num_devices);
- return -EINVAL;
- }
- zram_major = register_blkdev(0, "zram");
- if (zram_major <= 0) {
- pr_warn("Unable to get major number\n");
- return -EBUSY;
- }
- /* Allocate the device array and initialize each one */
- zram_devices = kzalloc(num_devices * sizeof(struct zram), GFP_KERNEL);
- if (!zram_devices) {
- unregister_blkdev(zram_major, "zram");
- return -ENOMEM;
- }
- for (dev_id = 0; dev_id < num_devices; dev_id++) {
- ret = create_device(&zram_devices[dev_id], dev_id);
- if (ret)
- goto out_error;
- }
- pr_info("Created %u device(s)\n", num_devices);
- return 0;
- out_error:
- destroy_devices(dev_id);
- return ret;
- }
- static void __exit zram_exit(void)
- {
- destroy_devices(num_devices);
- }
- module_init(zram_init);
- module_exit(zram_exit);
- module_param(num_devices, uint, 0);
- MODULE_PARM_DESC(num_devices, "Number of zram devices");
- MODULE_LICENSE("Dual BSD/GPL");
- MODULE_AUTHOR("Nitin Gupta <ngupta@vflare.org>");
- MODULE_DESCRIPTION("Compressed RAM Block Device");
|