2009-09-22 11:56:53 +07:00
|
|
|
/*
|
2010-06-01 15:01:25 +07:00
|
|
|
* Compressed RAM block device
|
2009-09-22 11:56:53 +07:00
|
|
|
*
|
2010-01-28 22:51:35 +07:00
|
|
|
* Copyright (C) 2008, 2009, 2010 Nitin Gupta
|
2014-01-31 06:45:55 +07:00
|
|
|
* 2012, 2013 Minchan Kim
|
2009-09-22 11:56:53 +07:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
2010-06-01 15:01:25 +07:00
|
|
|
#ifndef _ZRAM_DRV_H_
|
|
|
|
#define _ZRAM_DRV_H_
|
2009-09-22 11:56:53 +07:00
|
|
|
|
2010-01-28 22:43:37 +07:00
|
|
|
#include <linux/spinlock.h>
|
2014-01-31 06:45:50 +07:00
|
|
|
#include <linux/zsmalloc.h>
|
2009-09-22 11:56:53 +07:00
|
|
|
|
2014-04-08 05:38:12 +07:00
|
|
|
#include "zcomp.h"
|
|
|
|
|
2009-09-22 11:56:53 +07:00
|
|
|
/*
|
|
|
|
* Some arbitrary value. This is just to catch
|
|
|
|
* invalid value for num_devices module parameter.
|
|
|
|
*/
|
|
|
|
static const unsigned max_num_devices = 32;
|
|
|
|
|
|
|
|
/*-- Configurable parameters */
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Pages that compress to size greater than this are stored
|
|
|
|
* uncompressed in memory.
|
|
|
|
*/
|
2011-09-10 06:01:00 +07:00
|
|
|
static const size_t max_zpage_size = PAGE_SIZE / 4 * 3;
|
2009-09-22 11:56:53 +07:00
|
|
|
|
|
|
|
/*
|
2010-05-13 15:54:21 +07:00
|
|
|
* NOTE: max_zpage_size must be less than or equal to:
|
2012-10-10 06:49:52 +07:00
|
|
|
* ZS_MAX_ALLOC_SIZE. Otherwise, zs_malloc() would
|
|
|
|
* always return failure.
|
2009-09-22 11:56:53 +07:00
|
|
|
*/
|
|
|
|
|
|
|
|
/*-- End of configurable params */
|
|
|
|
|
|
|
|
#define SECTOR_SHIFT 9
|
|
|
|
#define SECTOR_SIZE (1 << SECTOR_SHIFT)
|
|
|
|
#define SECTORS_PER_PAGE_SHIFT (PAGE_SHIFT - SECTOR_SHIFT)
|
|
|
|
#define SECTORS_PER_PAGE (1 << SECTORS_PER_PAGE_SHIFT)
|
2011-06-10 20:28:48 +07:00
|
|
|
#define ZRAM_LOGICAL_BLOCK_SHIFT 12
|
|
|
|
#define ZRAM_LOGICAL_BLOCK_SIZE (1 << ZRAM_LOGICAL_BLOCK_SHIFT)
|
|
|
|
#define ZRAM_SECTOR_PER_LOGICAL_BLOCK \
|
|
|
|
(1 << (ZRAM_LOGICAL_BLOCK_SHIFT - SECTOR_SHIFT))
|
2009-09-22 11:56:53 +07:00
|
|
|
|
2010-06-01 15:01:25 +07:00
|
|
|
/* Flags for zram pages (table[page_no].flags) */
|
|
|
|
enum zram_pageflags {
|
2009-09-22 11:56:53 +07:00
|
|
|
/* Page consists entirely of zeros */
|
2010-06-01 15:01:25 +07:00
|
|
|
ZRAM_ZERO,
|
2009-09-22 11:56:53 +07:00
|
|
|
|
2010-06-01 15:01:25 +07:00
|
|
|
__NR_ZRAM_PAGEFLAGS,
|
2009-09-22 11:56:53 +07:00
|
|
|
};
|
|
|
|
|
|
|
|
/*-- Data structures */
|
|
|
|
|
2010-06-01 15:01:25 +07:00
|
|
|
/* Allocated for each disk page */
|
2009-09-22 11:56:53 +07:00
|
|
|
struct table {
|
2012-06-08 13:39:25 +07:00
|
|
|
unsigned long handle;
|
2012-01-10 05:51:59 +07:00
|
|
|
u16 size; /* object size (excluding header) */
|
2009-09-22 11:56:53 +07:00
|
|
|
u8 flags;
|
2012-06-08 06:03:48 +07:00
|
|
|
} __aligned(4);
|
2009-09-22 11:56:53 +07:00
|
|
|
|
2010-06-01 15:01:25 +07:00
|
|
|
struct zram_stats {
|
2014-04-08 05:38:03 +07:00
|
|
|
atomic64_t compr_data_size; /* compressed size of pages stored */
|
2013-06-06 23:07:31 +07:00
|
|
|
atomic64_t num_reads; /* failed + successful */
|
|
|
|
atomic64_t num_writes; /* --do-- */
|
|
|
|
atomic64_t failed_reads; /* should NEVER! happen */
|
|
|
|
atomic64_t failed_writes; /* can happen when memory is too low */
|
|
|
|
atomic64_t invalid_io; /* non-page-aligned I/O requests */
|
|
|
|
atomic64_t notify_free; /* no. of swap slot free notifications */
|
2014-04-08 05:38:03 +07:00
|
|
|
atomic64_t zero_pages; /* no. of zero filled pages */
|
|
|
|
atomic64_t pages_stored; /* no. of pages currently stored */
|
2009-09-22 11:56:53 +07:00
|
|
|
};
|
|
|
|
|
2013-02-06 06:48:53 +07:00
|
|
|
struct zram_meta {
|
2014-01-31 06:46:03 +07:00
|
|
|
rwlock_t tb_lock; /* protect table */
|
2009-09-22 11:56:53 +07:00
|
|
|
struct table *table;
|
2013-02-06 06:48:53 +07:00
|
|
|
struct zs_pool *mem_pool;
|
|
|
|
};
|
|
|
|
|
|
|
|
struct zram {
|
|
|
|
struct zram_meta *meta;
|
2009-09-22 11:56:53 +07:00
|
|
|
struct request_queue *queue;
|
|
|
|
struct gendisk *disk;
|
2014-04-08 05:38:12 +07:00
|
|
|
struct zcomp *comp;
|
|
|
|
|
2011-09-06 20:02:11 +07:00
|
|
|
/* Prevent concurrent execution of device init, reset and R/W request */
|
|
|
|
struct rw_semaphore init_lock;
|
2009-09-22 11:56:53 +07:00
|
|
|
/*
|
2010-06-01 15:01:25 +07:00
|
|
|
* This is the limit on amount of *uncompressed* worth of data
|
|
|
|
* we can store in a disk.
|
2009-09-22 11:56:53 +07:00
|
|
|
*/
|
2010-08-10 00:26:47 +07:00
|
|
|
u64 disksize; /* bytes */
|
zram: add multi stream functionality
Existing zram (zcomp) implementation has only one compression stream
(buffer and algorithm private part), so in order to prevent data
corruption only one write (compress operation) can use this compression
stream, forcing all concurrent write operations to wait for stream lock
to be released. This patch changes zcomp to keep a compression streams
list of user-defined size (via sysfs device attr). Each write operation
still exclusively holds compression stream, the difference is that we
can have N write operations (depending on size of streams list)
executing in parallel. See TEST section later in commit message for
performance data.
Introduce struct zcomp_strm_multi and a set of functions to manage
zcomp_strm stream access. zcomp_strm_multi has a list of idle
zcomp_strm structs, spinlock to protect idle list and wait queue, making
it possible to perform parallel compressions.
The following set of functions added:
- zcomp_strm_multi_find()/zcomp_strm_multi_release()
find and release a compression stream, implement required locking
- zcomp_strm_multi_create()/zcomp_strm_multi_destroy()
create and destroy zcomp_strm_multi
zcomp ->strm_find() and ->strm_release() callbacks are set during
initialisation to zcomp_strm_multi_find()/zcomp_strm_multi_release()
correspondingly.
Each time zcomp issues a zcomp_strm_multi_find() call, the following set
of operations performed:
- spin lock strm_lock
- if idle list is not empty, remove zcomp_strm from idle list, spin
unlock and return zcomp stream pointer to caller
- if idle list is empty, current adds itself to wait queue. it will be
awaken by zcomp_strm_multi_release() caller.
zcomp_strm_multi_release():
- spin lock strm_lock
- add zcomp stream to idle list
- spin unlock, wake up sleeper
Minchan Kim reported that spinlock-based locking scheme has demonstrated
a severe perfomance regression for single compression stream case,
comparing to mutex-based (see https://lkml.org/lkml/2014/2/18/16)
base spinlock mutex
==Initial write ==Initial write ==Initial write
records: 5 records: 5 records: 5
avg: 1642424.35 avg: 699610.40 avg: 1655583.71
std: 39890.95(2.43%) std: 232014.19(33.16%) std: 52293.96
max: 1690170.94 max: 1163473.45 max: 1697164.75
min: 1568669.52 min: 573429.88 min: 1553410.23
==Rewrite ==Rewrite ==Rewrite
records: 5 records: 5 records: 5
avg: 1611775.39 avg: 501406.64 avg: 1684419.11
std: 17144.58(1.06%) std: 15354.41(3.06%) std: 18367.42
max: 1641800.95 max: 531356.78 max: 1706445.84
min: 1593515.27 min: 488817.78 min: 1655335.73
When only one compression stream available, mutex with spin on owner
tends to perform much better than frequent wait_event()/wake_up(). This
is why single stream implemented as a special case with mutex locking.
Introduce and document zram device attribute max_comp_streams. This
attr shows and stores current zcomp's max number of zcomp streams
(max_strm). Extend zcomp's zcomp_create() with `max_strm' parameter.
`max_strm' limits the number of zcomp_strm structs in compression
backend's idle list (max_comp_streams).
max_comp_streams used during initialisation as follows:
-- passing to zcomp_create() max_strm equals to 1 will initialise zcomp
using single compression stream zcomp_strm_single (mutex-based locking).
-- passing to zcomp_create() max_strm greater than 1 will initialise zcomp
using multi compression stream zcomp_strm_multi (spinlock-based locking).
default max_comp_streams value is 1, meaning that zram with single stream
will be initialised.
Later patch will introduce configuration knob to change max_comp_streams
on already initialised and used zcomp.
TEST
iozone -t 3 -R -r 16K -s 60M -I +Z
test base 1 strm (mutex) 3 strm (spinlock)
-----------------------------------------------------------------------
Initial write 589286.78 583518.39 718011.05
Rewrite 604837.97 596776.38 1515125.72
Random write 584120.11 595714.58 1388850.25
Pwrite 535731.17 541117.38 739295.27
Fwrite 1418083.88 1478612.72 1484927.06
Usage example:
set max_comp_streams to 4
echo 4 > /sys/block/zram0/max_comp_streams
show current max_comp_streams (default value is 1).
cat /sys/block/zram0/max_comp_streams
Signed-off-by: Sergey Senozhatsky <sergey.senozhatsky@gmail.com>
Acked-by: Minchan Kim <minchan@kernel.org>
Cc: Jerome Marchand <jmarchan@redhat.com>
Cc: Nitin Gupta <ngupta@vflare.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2014-04-08 05:38:14 +07:00
|
|
|
int max_comp_streams;
|
2010-06-01 15:01:25 +07:00
|
|
|
struct zram_stats stats;
|
2014-04-08 05:38:17 +07:00
|
|
|
char compressor[10];
|
2009-09-22 11:56:53 +07:00
|
|
|
};
|
2010-01-28 22:43:37 +07:00
|
|
|
#endif
|