blob: 85cc29c93d93a7d9032e3bc9f2d940db8e8bba0b [file] [log] [blame]
Nitin Gupta61989a82012-01-09 16:51:56 -06001/*
2 * zsmalloc memory allocator
3 *
4 * Copyright (C) 2011 Nitin Gupta
Minchan Kim31fc00b2014-01-30 15:45:55 -08005 * Copyright (C) 2012, 2013 Minchan Kim
Nitin Gupta61989a82012-01-09 16:51:56 -06006 *
7 * This code is released using a dual license strategy: BSD/GPL
8 * You can choose the license that better fits your requirements.
9 *
10 * Released under the terms of 3-clause BSD License
11 * Released under the terms of GNU General Public License Version 2.0
12 */
13
Nitin Gupta2db51da2012-06-09 17:41:14 -070014/*
Nitin Gupta2db51da2012-06-09 17:41:14 -070015 * Following is how we use various fields and flags of underlying
16 * struct page(s) to form a zspage.
17 *
18 * Usage of struct page fields:
Minchan Kim37836892016-07-26 15:23:23 -070019 * page->private: points to zspage
Minchan Kim48b48002016-07-26 15:23:31 -070020 * page->freelist(index): links together all component pages of a zspage
21 * For the huge page, this is always 0, so we use this field
22 * to store handle.
Ganesh Mahendranfd854462016-07-28 15:47:54 -070023 * page->units: first object offset in a subpage of zspage
Nitin Gupta2db51da2012-06-09 17:41:14 -070024 *
25 * Usage of struct page flags:
26 * PG_private: identifies the first component page
Xishi Qiu399d8ee2017-02-22 15:45:01 -080027 * PG_owner_priv_1: identifies the huge component page
Nitin Gupta2db51da2012-06-09 17:41:14 -070028 *
29 */
30
Dan Streetman4abaac92016-05-26 15:16:27 -070031#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
32
Nitin Gupta61989a82012-01-09 16:51:56 -060033#include <linux/module.h>
34#include <linux/kernel.h>
Minchan Kim312fcae2015-04-15 16:15:30 -070035#include <linux/sched.h>
Ingo Molnar50d34392017-02-05 16:03:58 +010036#include <linux/magic.h>
Nitin Gupta61989a82012-01-09 16:51:56 -060037#include <linux/bitops.h>
38#include <linux/errno.h>
39#include <linux/highmem.h>
Nitin Gupta61989a82012-01-09 16:51:56 -060040#include <linux/string.h>
41#include <linux/slab.h>
42#include <asm/tlbflush.h>
43#include <asm/pgtable.h>
44#include <linux/cpumask.h>
45#include <linux/cpu.h>
Seth Jennings0cbb6132012-02-13 08:47:49 -060046#include <linux/vmalloc.h>
Sergey Senozhatsky759b26b2015-11-06 16:29:29 -080047#include <linux/preempt.h>
Seth Jennings0959c632012-08-08 15:12:17 +090048#include <linux/spinlock.h>
Aliaksei Karaliou93144ca2018-01-31 16:18:40 -080049#include <linux/shrinker.h>
Seth Jennings0959c632012-08-08 15:12:17 +090050#include <linux/types.h>
Ganesh Mahendran0f050d92015-02-12 15:00:54 -080051#include <linux/debugfs.h>
Minchan Kimbcf16472014-01-30 15:45:50 -080052#include <linux/zsmalloc.h>
Dan Streetmanc7957792014-08-06 16:08:38 -070053#include <linux/zpool.h>
Minchan Kim48b48002016-07-26 15:23:31 -070054#include <linux/mount.h>
Minchan Kimdd4123f2016-07-26 15:26:50 -070055#include <linux/migrate.h>
Henry Burnsed11e602019-08-24 17:55:06 -070056#include <linux/wait.h>
Minchan Kim48b48002016-07-26 15:23:31 -070057#include <linux/pagemap.h>
Sergey Senozhatskycdc346b2018-01-04 16:18:02 -080058#include <linux/fs.h>
Minchan Kim48b48002016-07-26 15:23:31 -070059
60#define ZSPAGE_MAGIC 0x58
Seth Jennings0959c632012-08-08 15:12:17 +090061
62/*
63 * This must be power of 2 and greater than of equal to sizeof(link_free).
64 * These two conditions ensure that any 'struct link_free' itself doesn't
65 * span more than 1 page which avoids complex case of mapping 2 pages simply
66 * to restore link_free pointer values.
67 */
68#define ZS_ALIGN 8
69
70/*
71 * A single 'zspage' is composed of up to 2^N discontiguous 0-order (single)
72 * pages. ZS_MAX_ZSPAGE_ORDER defines upper limit on N.
73 */
74#define ZS_MAX_ZSPAGE_ORDER 2
75#define ZS_MAX_PAGES_PER_ZSPAGE (_AC(1, UL) << ZS_MAX_ZSPAGE_ORDER)
76
Minchan Kim2e40e162015-04-15 16:15:23 -070077#define ZS_HANDLE_SIZE (sizeof(unsigned long))
78
Seth Jennings0959c632012-08-08 15:12:17 +090079/*
80 * Object location (<PFN>, <obj_idx>) is encoded as
Nitin Cuptac3e3e882013-12-11 11:04:37 +090081 * as single (unsigned long) handle value.
Seth Jennings0959c632012-08-08 15:12:17 +090082 *
Minchan Kimbfd093f2016-07-26 15:23:28 -070083 * Note that object index <obj_idx> starts from 0.
Seth Jennings0959c632012-08-08 15:12:17 +090084 *
85 * This is made more complicated by various memory models and PAE.
86 */
87
Kirill A. Shutemov02390b82018-02-14 14:16:49 +030088#ifndef MAX_POSSIBLE_PHYSMEM_BITS
89#ifdef MAX_PHYSMEM_BITS
90#define MAX_POSSIBLE_PHYSMEM_BITS MAX_PHYSMEM_BITS
91#else
Seth Jennings0959c632012-08-08 15:12:17 +090092/*
93 * If this definition of MAX_PHYSMEM_BITS is used, OBJ_INDEX_BITS will just
94 * be PAGE_SHIFT
95 */
Kirill A. Shutemov02390b82018-02-14 14:16:49 +030096#define MAX_POSSIBLE_PHYSMEM_BITS BITS_PER_LONG
Seth Jennings0959c632012-08-08 15:12:17 +090097#endif
98#endif
Kirill A. Shutemov02390b82018-02-14 14:16:49 +030099
100#define _PFN_BITS (MAX_POSSIBLE_PHYSMEM_BITS - PAGE_SHIFT)
Minchan Kim312fcae2015-04-15 16:15:30 -0700101
102/*
103 * Memory for allocating for handle keeps object position by
104 * encoding <page, obj_idx> and the encoded value has a room
105 * in least bit(ie, look at obj_to_location).
106 * We use the bit to synchronize between object access by
107 * user and migration.
108 */
109#define HANDLE_PIN_BIT 0
110
111/*
112 * Head in allocated object should have OBJ_ALLOCATED_TAG
113 * to identify the object was allocated or not.
114 * It's okay to add the status bit in the least bit because
115 * header keeps handle which is 4byte-aligned address so we
116 * have room for two bit at least.
117 */
118#define OBJ_ALLOCATED_TAG 1
119#define OBJ_TAG_BITS 1
120#define OBJ_INDEX_BITS (BITS_PER_LONG - _PFN_BITS - OBJ_TAG_BITS)
Seth Jennings0959c632012-08-08 15:12:17 +0900121#define OBJ_INDEX_MASK ((_AC(1, UL) << OBJ_INDEX_BITS) - 1)
122
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -0700123#define FULLNESS_BITS 2
124#define CLASS_BITS 8
125#define ISOLATED_BITS 3
126#define MAGIC_VAL_BITS 8
127
Seth Jennings0959c632012-08-08 15:12:17 +0900128#define MAX(a, b) ((a) >= (b) ? (a) : (b))
129/* ZS_MIN_ALLOC_SIZE must be multiple of ZS_ALIGN */
130#define ZS_MIN_ALLOC_SIZE \
131 MAX(32, (ZS_MAX_PAGES_PER_ZSPAGE << PAGE_SHIFT >> OBJ_INDEX_BITS))
Minchan Kim2e40e162015-04-15 16:15:23 -0700132/* each chunk includes extra space to keep handle */
Minchan Kim7b60a682015-04-15 16:15:39 -0700133#define ZS_MAX_ALLOC_SIZE PAGE_SIZE
Seth Jennings0959c632012-08-08 15:12:17 +0900134
135/*
Weijie Yang7eb52512014-06-04 16:11:08 -0700136 * On systems with 4K page size, this gives 255 size classes! There is a
Seth Jennings0959c632012-08-08 15:12:17 +0900137 * trader-off here:
138 * - Large number of size classes is potentially wasteful as free page are
139 * spread across these classes
140 * - Small number of size classes causes large internal fragmentation
141 * - Probably its better to use specific size classes (empirically
142 * determined). NOTE: all those class sizes must be set as multiple of
143 * ZS_ALIGN to make sure link_free itself never has to span 2 pages.
144 *
145 * ZS_MIN_ALLOC_SIZE and ZS_SIZE_CLASS_DELTA must be multiple of ZS_ALIGN
146 * (reason above)
147 */
Minchan Kim37836892016-07-26 15:23:23 -0700148#define ZS_SIZE_CLASS_DELTA (PAGE_SIZE >> CLASS_BITS)
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -0700149#define ZS_SIZE_CLASSES (DIV_ROUND_UP(ZS_MAX_ALLOC_SIZE - ZS_MIN_ALLOC_SIZE, \
150 ZS_SIZE_CLASS_DELTA) + 1)
Seth Jennings0959c632012-08-08 15:12:17 +0900151
Seth Jennings0959c632012-08-08 15:12:17 +0900152enum fullness_group {
Seth Jennings0959c632012-08-08 15:12:17 +0900153 ZS_EMPTY,
Minchan Kim48b48002016-07-26 15:23:31 -0700154 ZS_ALMOST_EMPTY,
155 ZS_ALMOST_FULL,
156 ZS_FULL,
157 NR_ZS_FULLNESS,
Seth Jennings0959c632012-08-08 15:12:17 +0900158};
159
Ganesh Mahendran0f050d92015-02-12 15:00:54 -0800160enum zs_stat_type {
Minchan Kim48b48002016-07-26 15:23:31 -0700161 CLASS_EMPTY,
162 CLASS_ALMOST_EMPTY,
163 CLASS_ALMOST_FULL,
164 CLASS_FULL,
Ganesh Mahendran0f050d92015-02-12 15:00:54 -0800165 OBJ_ALLOCATED,
166 OBJ_USED,
Minchan Kim48b48002016-07-26 15:23:31 -0700167 NR_ZS_STAT_TYPE,
Ganesh Mahendran0f050d92015-02-12 15:00:54 -0800168};
169
Ganesh Mahendran0f050d92015-02-12 15:00:54 -0800170struct zs_size_stat {
171 unsigned long objs[NR_ZS_STAT_TYPE];
172};
173
Sergey Senozhatsky57244592015-09-08 15:04:27 -0700174#ifdef CONFIG_ZSMALLOC_STAT
175static struct dentry *zs_stat_root;
Ganesh Mahendran0f050d92015-02-12 15:00:54 -0800176#endif
177
Minchan Kim48b48002016-07-26 15:23:31 -0700178#ifdef CONFIG_COMPACTION
179static struct vfsmount *zsmalloc_mnt;
180#endif
181
Seth Jennings0959c632012-08-08 15:12:17 +0900182/*
183 * We assign a page to ZS_ALMOST_EMPTY fullness group when:
184 * n <= N / f, where
185 * n = number of allocated objects
186 * N = total number of objects zspage can store
Wang Sheng-Hui6dd97372014-10-09 15:29:59 -0700187 * f = fullness_threshold_frac
Seth Jennings0959c632012-08-08 15:12:17 +0900188 *
189 * Similarly, we assign zspage to:
190 * ZS_ALMOST_FULL when n > N / f
191 * ZS_EMPTY when n == 0
192 * ZS_FULL when n == N
193 *
194 * (see: fix_fullness_group())
195 */
196static const int fullness_threshold_frac = 4;
Sergey Senozhatsky010b4952018-04-05 16:24:43 -0700197static size_t huge_class_size;
Seth Jennings0959c632012-08-08 15:12:17 +0900198
199struct size_class {
Sergey Senozhatsky57244592015-09-08 15:04:27 -0700200 spinlock_t lock;
Minchan Kim48b48002016-07-26 15:23:31 -0700201 struct list_head fullness_list[NR_ZS_FULLNESS];
Seth Jennings0959c632012-08-08 15:12:17 +0900202 /*
203 * Size of objects stored in this class. Must be multiple
204 * of ZS_ALIGN.
205 */
206 int size;
Minchan Kim1fc6e272016-07-26 15:23:11 -0700207 int objs_per_zspage;
Weijie Yang7dfa4612016-01-14 15:22:40 -0800208 /* Number of PAGE_SIZE sized pages to combine to form a 'zspage' */
209 int pages_per_zspage;
Minchan Kim48b48002016-07-26 15:23:31 -0700210
211 unsigned int index;
212 struct zs_size_stat stats;
Seth Jennings0959c632012-08-08 15:12:17 +0900213};
214
Minchan Kim48b48002016-07-26 15:23:31 -0700215/* huge object: pages_per_zspage == 1 && maxobj_per_zspage == 1 */
216static void SetPageHugeObject(struct page *page)
217{
218 SetPageOwnerPriv1(page);
219}
220
221static void ClearPageHugeObject(struct page *page)
222{
223 ClearPageOwnerPriv1(page);
224}
225
226static int PageHugeObject(struct page *page)
227{
228 return PageOwnerPriv1(page);
229}
230
Seth Jennings0959c632012-08-08 15:12:17 +0900231/*
232 * Placed within free objects to form a singly linked list.
Minchan Kim37836892016-07-26 15:23:23 -0700233 * For every zspage, zspage->freeobj gives head of this list.
Seth Jennings0959c632012-08-08 15:12:17 +0900234 *
235 * This must be power of 2 and less than or equal to ZS_ALIGN
236 */
237struct link_free {
Minchan Kim2e40e162015-04-15 16:15:23 -0700238 union {
239 /*
Minchan Kimbfd093f2016-07-26 15:23:28 -0700240 * Free object index;
Minchan Kim2e40e162015-04-15 16:15:23 -0700241 * It's valid for non-allocated object
242 */
Minchan Kimbfd093f2016-07-26 15:23:28 -0700243 unsigned long next;
Minchan Kim2e40e162015-04-15 16:15:23 -0700244 /*
245 * Handle of allocated object.
246 */
247 unsigned long handle;
248 };
Seth Jennings0959c632012-08-08 15:12:17 +0900249};
250
251struct zs_pool {
Sergey SENOZHATSKY6f3526d2015-11-06 16:29:21 -0800252 const char *name;
Ganesh Mahendran0f050d92015-02-12 15:00:54 -0800253
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -0700254 struct size_class *size_class[ZS_SIZE_CLASSES];
Minchan Kim2e40e162015-04-15 16:15:23 -0700255 struct kmem_cache *handle_cachep;
Minchan Kim37836892016-07-26 15:23:23 -0700256 struct kmem_cache *zspage_cachep;
Seth Jennings0959c632012-08-08 15:12:17 +0900257
Minchan Kim13de8932014-10-09 15:29:48 -0700258 atomic_long_t pages_allocated;
Ganesh Mahendran0f050d92015-02-12 15:00:54 -0800259
Sergey Senozhatsky7d3f3932015-09-08 15:04:35 -0700260 struct zs_pool_stats stats;
Sergey Senozhatskyab9d3062015-09-08 15:04:41 -0700261
262 /* Compact classes */
263 struct shrinker shrinker;
Aliaksei Karaliou93144ca2018-01-31 16:18:40 -0800264
Ganesh Mahendran0f050d92015-02-12 15:00:54 -0800265#ifdef CONFIG_ZSMALLOC_STAT
266 struct dentry *stat_dentry;
267#endif
Minchan Kim48b48002016-07-26 15:23:31 -0700268#ifdef CONFIG_COMPACTION
269 struct inode *inode;
270 struct work_struct free_work;
Henry Burnsed11e602019-08-24 17:55:06 -0700271 /* A wait queue for when migration races with async_free_zspage() */
272 struct wait_queue_head migration_wait;
273 atomic_long_t isolated_pages;
274 bool destroying;
Minchan Kim48b48002016-07-26 15:23:31 -0700275#endif
Seth Jennings0959c632012-08-08 15:12:17 +0900276};
Nitin Gupta61989a82012-01-09 16:51:56 -0600277
Minchan Kim37836892016-07-26 15:23:23 -0700278struct zspage {
279 struct {
280 unsigned int fullness:FULLNESS_BITS;
Minchan Kim85d492f2017-04-13 14:56:40 -0700281 unsigned int class:CLASS_BITS + 1;
Minchan Kim48b48002016-07-26 15:23:31 -0700282 unsigned int isolated:ISOLATED_BITS;
283 unsigned int magic:MAGIC_VAL_BITS;
Minchan Kim37836892016-07-26 15:23:23 -0700284 };
285 unsigned int inuse;
Minchan Kimbfd093f2016-07-26 15:23:28 -0700286 unsigned int freeobj;
Minchan Kim37836892016-07-26 15:23:23 -0700287 struct page *first_page;
288 struct list_head list; /* fullness list */
Minchan Kim48b48002016-07-26 15:23:31 -0700289#ifdef CONFIG_COMPACTION
290 rwlock_t lock;
291#endif
Minchan Kim37836892016-07-26 15:23:23 -0700292};
Nitin Gupta61989a82012-01-09 16:51:56 -0600293
Seth Jenningsf5536462012-07-18 11:55:56 -0500294struct mapping_area {
Minchan Kim1b945ae2013-12-11 11:04:36 +0900295#ifdef CONFIG_PGTABLE_MAPPING
Seth Jenningsf5536462012-07-18 11:55:56 -0500296 struct vm_struct *vm; /* vm area for mapping object that span pages */
297#else
298 char *vm_buf; /* copy buffer for objects that span pages */
299#endif
300 char *vm_addr; /* address of kmap_atomic()'ed pages */
301 enum zs_mapmode vm_mm; /* mapping mode */
302};
303
Minchan Kim48b48002016-07-26 15:23:31 -0700304#ifdef CONFIG_COMPACTION
305static int zs_register_migration(struct zs_pool *pool);
306static void zs_unregister_migration(struct zs_pool *pool);
307static void migrate_lock_init(struct zspage *zspage);
308static void migrate_read_lock(struct zspage *zspage);
309static void migrate_read_unlock(struct zspage *zspage);
310static void kick_deferred_free(struct zs_pool *pool);
311static void init_deferred_free(struct zs_pool *pool);
312static void SetZsPageMovable(struct zs_pool *pool, struct zspage *zspage);
313#else
314static int zsmalloc_mount(void) { return 0; }
315static void zsmalloc_unmount(void) {}
316static int zs_register_migration(struct zs_pool *pool) { return 0; }
317static void zs_unregister_migration(struct zs_pool *pool) {}
318static void migrate_lock_init(struct zspage *zspage) {}
319static void migrate_read_lock(struct zspage *zspage) {}
320static void migrate_read_unlock(struct zspage *zspage) {}
321static void kick_deferred_free(struct zs_pool *pool) {}
322static void init_deferred_free(struct zs_pool *pool) {}
323static void SetZsPageMovable(struct zs_pool *pool, struct zspage *zspage) {}
324#endif
325
Minchan Kim37836892016-07-26 15:23:23 -0700326static int create_cache(struct zs_pool *pool)
Minchan Kim2e40e162015-04-15 16:15:23 -0700327{
328 pool->handle_cachep = kmem_cache_create("zs_handle", ZS_HANDLE_SIZE,
329 0, 0, NULL);
Minchan Kim37836892016-07-26 15:23:23 -0700330 if (!pool->handle_cachep)
331 return 1;
332
333 pool->zspage_cachep = kmem_cache_create("zspage", sizeof(struct zspage),
334 0, 0, NULL);
335 if (!pool->zspage_cachep) {
336 kmem_cache_destroy(pool->handle_cachep);
337 pool->handle_cachep = NULL;
338 return 1;
339 }
340
341 return 0;
Minchan Kim2e40e162015-04-15 16:15:23 -0700342}
343
Minchan Kim37836892016-07-26 15:23:23 -0700344static void destroy_cache(struct zs_pool *pool)
Minchan Kim2e40e162015-04-15 16:15:23 -0700345{
Sergey Senozhatskycd10add2015-09-08 15:04:55 -0700346 kmem_cache_destroy(pool->handle_cachep);
Minchan Kim37836892016-07-26 15:23:23 -0700347 kmem_cache_destroy(pool->zspage_cachep);
Minchan Kim2e40e162015-04-15 16:15:23 -0700348}
349
Minchan Kim37836892016-07-26 15:23:23 -0700350static unsigned long cache_alloc_handle(struct zs_pool *pool, gfp_t gfp)
Minchan Kim2e40e162015-04-15 16:15:23 -0700351{
352 return (unsigned long)kmem_cache_alloc(pool->handle_cachep,
Minchan Kim48b48002016-07-26 15:23:31 -0700353 gfp & ~(__GFP_HIGHMEM|__GFP_MOVABLE));
Minchan Kim2e40e162015-04-15 16:15:23 -0700354}
355
Minchan Kim37836892016-07-26 15:23:23 -0700356static void cache_free_handle(struct zs_pool *pool, unsigned long handle)
Minchan Kim2e40e162015-04-15 16:15:23 -0700357{
358 kmem_cache_free(pool->handle_cachep, (void *)handle);
359}
360
Minchan Kim37836892016-07-26 15:23:23 -0700361static struct zspage *cache_alloc_zspage(struct zs_pool *pool, gfp_t flags)
362{
Minchan Kim48b48002016-07-26 15:23:31 -0700363 return kmem_cache_alloc(pool->zspage_cachep,
364 flags & ~(__GFP_HIGHMEM|__GFP_MOVABLE));
Xishi Qiu399d8ee2017-02-22 15:45:01 -0800365}
Minchan Kim37836892016-07-26 15:23:23 -0700366
367static void cache_free_zspage(struct zs_pool *pool, struct zspage *zspage)
368{
369 kmem_cache_free(pool->zspage_cachep, zspage);
370}
371
Minchan Kim2e40e162015-04-15 16:15:23 -0700372static void record_obj(unsigned long handle, unsigned long obj)
373{
Junil Leec102f072016-01-20 14:58:18 -0800374 /*
375 * lsb of @obj represents handle lock while other bits
376 * represent object value the handle is pointing so
377 * updating shouldn't do store tearing.
378 */
379 WRITE_ONCE(*(unsigned long *)handle, obj);
Minchan Kim2e40e162015-04-15 16:15:23 -0700380}
381
Dan Streetmanc7957792014-08-06 16:08:38 -0700382/* zpool driver */
383
384#ifdef CONFIG_ZPOOL
385
Sergey SENOZHATSKY6f3526d2015-11-06 16:29:21 -0800386static void *zs_zpool_create(const char *name, gfp_t gfp,
Krzysztof Kozlowski78672772015-09-08 15:05:03 -0700387 const struct zpool_ops *zpool_ops,
Dan Streetman479305f2015-06-25 15:00:40 -0700388 struct zpool *zpool)
Dan Streetmanc7957792014-08-06 16:08:38 -0700389{
Sergey Senozhatskyd0d8da22016-05-20 16:59:48 -0700390 /*
391 * Ignore global gfp flags: zs_malloc() may be invoked from
392 * different contexts and its caller must provide a valid
393 * gfp mask.
394 */
395 return zs_create_pool(name);
Dan Streetmanc7957792014-08-06 16:08:38 -0700396}
397
398static void zs_zpool_destroy(void *pool)
399{
400 zs_destroy_pool(pool);
401}
402
403static int zs_zpool_malloc(void *pool, size_t size, gfp_t gfp,
404 unsigned long *handle)
405{
Sergey Senozhatskyd0d8da22016-05-20 16:59:48 -0700406 *handle = zs_malloc(pool, size, gfp);
Dan Streetmanc7957792014-08-06 16:08:38 -0700407 return *handle ? 0 : -1;
408}
409static void zs_zpool_free(void *pool, unsigned long handle)
410{
411 zs_free(pool, handle);
412}
413
Dan Streetmanc7957792014-08-06 16:08:38 -0700414static void *zs_zpool_map(void *pool, unsigned long handle,
415 enum zpool_mapmode mm)
416{
417 enum zs_mapmode zs_mm;
418
419 switch (mm) {
420 case ZPOOL_MM_RO:
421 zs_mm = ZS_MM_RO;
422 break;
423 case ZPOOL_MM_WO:
424 zs_mm = ZS_MM_WO;
425 break;
426 case ZPOOL_MM_RW: /* fallthru */
427 default:
428 zs_mm = ZS_MM_RW;
429 break;
430 }
431
432 return zs_map_object(pool, handle, zs_mm);
433}
434static void zs_zpool_unmap(void *pool, unsigned long handle)
435{
436 zs_unmap_object(pool, handle);
437}
438
439static u64 zs_zpool_total_size(void *pool)
440{
Minchan Kim722cdc12014-10-09 15:29:50 -0700441 return zs_get_total_pages(pool) << PAGE_SHIFT;
Dan Streetmanc7957792014-08-06 16:08:38 -0700442}
443
444static struct zpool_driver zs_zpool_driver = {
445 .type = "zsmalloc",
446 .owner = THIS_MODULE,
447 .create = zs_zpool_create,
448 .destroy = zs_zpool_destroy,
449 .malloc = zs_zpool_malloc,
450 .free = zs_zpool_free,
Dan Streetmanc7957792014-08-06 16:08:38 -0700451 .map = zs_zpool_map,
452 .unmap = zs_zpool_unmap,
453 .total_size = zs_zpool_total_size,
454};
455
Kees Cook137f8cf2014-08-29 15:18:40 -0700456MODULE_ALIAS("zpool-zsmalloc");
Dan Streetmanc7957792014-08-06 16:08:38 -0700457#endif /* CONFIG_ZPOOL */
458
Nitin Gupta61989a82012-01-09 16:51:56 -0600459/* per-cpu VM mapping areas for zspage accesses that cross page boundaries */
460static DEFINE_PER_CPU(struct mapping_area, zs_map_area);
461
Minchan Kim48b48002016-07-26 15:23:31 -0700462static bool is_zspage_isolated(struct zspage *zspage)
463{
464 return zspage->isolated;
465}
466
Nick Desaulniers3457f412017-07-10 15:47:26 -0700467static __maybe_unused int is_first_page(struct page *page)
Nitin Gupta61989a82012-01-09 16:51:56 -0600468{
Minchan Kima27545bf2012-04-25 15:23:09 +0900469 return PagePrivate(page);
Nitin Gupta61989a82012-01-09 16:51:56 -0600470}
471
Minchan Kim48b48002016-07-26 15:23:31 -0700472/* Protected by class->lock */
Minchan Kim37836892016-07-26 15:23:23 -0700473static inline int get_zspage_inuse(struct zspage *zspage)
Nitin Gupta61989a82012-01-09 16:51:56 -0600474{
Minchan Kim37836892016-07-26 15:23:23 -0700475 return zspage->inuse;
Nitin Gupta61989a82012-01-09 16:51:56 -0600476}
477
Minchan Kim37836892016-07-26 15:23:23 -0700478static inline void set_zspage_inuse(struct zspage *zspage, int val)
Minchan Kim4f420472016-07-26 15:23:17 -0700479{
Minchan Kim37836892016-07-26 15:23:23 -0700480 zspage->inuse = val;
Minchan Kim4f420472016-07-26 15:23:17 -0700481}
482
Minchan Kim37836892016-07-26 15:23:23 -0700483static inline void mod_zspage_inuse(struct zspage *zspage, int val)
Minchan Kim4f420472016-07-26 15:23:17 -0700484{
Minchan Kim37836892016-07-26 15:23:23 -0700485 zspage->inuse += val;
Minchan Kim4f420472016-07-26 15:23:17 -0700486}
487
Minchan Kim48b48002016-07-26 15:23:31 -0700488static inline struct page *get_first_page(struct zspage *zspage)
489{
490 struct page *first_page = zspage->first_page;
491
492 VM_BUG_ON_PAGE(!is_first_page(first_page), first_page);
493 return first_page;
494}
495
Minchan Kim4f420472016-07-26 15:23:17 -0700496static inline int get_first_obj_offset(struct page *page)
497{
Minchan Kim48b48002016-07-26 15:23:31 -0700498 return page->units;
Minchan Kim4f420472016-07-26 15:23:17 -0700499}
500
501static inline void set_first_obj_offset(struct page *page, int offset)
502{
Minchan Kim48b48002016-07-26 15:23:31 -0700503 page->units = offset;
Minchan Kim4f420472016-07-26 15:23:17 -0700504}
505
Minchan Kimbfd093f2016-07-26 15:23:28 -0700506static inline unsigned int get_freeobj(struct zspage *zspage)
Minchan Kim4f420472016-07-26 15:23:17 -0700507{
Minchan Kimbfd093f2016-07-26 15:23:28 -0700508 return zspage->freeobj;
Minchan Kim4f420472016-07-26 15:23:17 -0700509}
510
Minchan Kimbfd093f2016-07-26 15:23:28 -0700511static inline void set_freeobj(struct zspage *zspage, unsigned int obj)
Minchan Kim4f420472016-07-26 15:23:17 -0700512{
Minchan Kimbfd093f2016-07-26 15:23:28 -0700513 zspage->freeobj = obj;
Minchan Kim4f420472016-07-26 15:23:17 -0700514}
515
Minchan Kim37836892016-07-26 15:23:23 -0700516static void get_zspage_mapping(struct zspage *zspage,
Minchan Kima4209462016-05-20 16:59:36 -0700517 unsigned int *class_idx,
Nitin Gupta61989a82012-01-09 16:51:56 -0600518 enum fullness_group *fullness)
519{
Minchan Kim48b48002016-07-26 15:23:31 -0700520 BUG_ON(zspage->magic != ZSPAGE_MAGIC);
521
Minchan Kim37836892016-07-26 15:23:23 -0700522 *fullness = zspage->fullness;
523 *class_idx = zspage->class;
Nitin Gupta61989a82012-01-09 16:51:56 -0600524}
525
Minchan Kim37836892016-07-26 15:23:23 -0700526static void set_zspage_mapping(struct zspage *zspage,
Minchan Kima4209462016-05-20 16:59:36 -0700527 unsigned int class_idx,
Nitin Gupta61989a82012-01-09 16:51:56 -0600528 enum fullness_group fullness)
529{
Minchan Kim37836892016-07-26 15:23:23 -0700530 zspage->class = class_idx;
531 zspage->fullness = fullness;
Nitin Gupta61989a82012-01-09 16:51:56 -0600532}
533
Nitin Cuptac3e3e882013-12-11 11:04:37 +0900534/*
535 * zsmalloc divides the pool into various size classes where each
536 * class maintains a list of zspages where each zspage is divided
537 * into equal sized chunks. Each allocation falls into one of these
538 * classes depending on its size. This function returns index of the
539 * size class which has chunk size big enough to hold the give size.
540 */
Nitin Gupta61989a82012-01-09 16:51:56 -0600541static int get_size_class_index(int size)
542{
543 int idx = 0;
544
545 if (likely(size > ZS_MIN_ALLOC_SIZE))
546 idx = DIV_ROUND_UP(size - ZS_MIN_ALLOC_SIZE,
547 ZS_SIZE_CLASS_DELTA);
548
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -0700549 return min_t(int, ZS_SIZE_CLASSES - 1, idx);
Nitin Gupta61989a82012-01-09 16:51:56 -0600550}
551
Matthias Kaehlcke3eb95fe2017-09-08 16:13:02 -0700552/* type can be of enum type zs_stat_type or fullness_group */
Minchan Kim248ca1b2015-04-15 16:15:42 -0700553static inline void zs_stat_inc(struct size_class *class,
Matthias Kaehlcke3eb95fe2017-09-08 16:13:02 -0700554 int type, unsigned long cnt)
Minchan Kim248ca1b2015-04-15 16:15:42 -0700555{
Minchan Kim48b48002016-07-26 15:23:31 -0700556 class->stats.objs[type] += cnt;
Minchan Kim248ca1b2015-04-15 16:15:42 -0700557}
558
Matthias Kaehlcke3eb95fe2017-09-08 16:13:02 -0700559/* type can be of enum type zs_stat_type or fullness_group */
Minchan Kim248ca1b2015-04-15 16:15:42 -0700560static inline void zs_stat_dec(struct size_class *class,
Matthias Kaehlcke3eb95fe2017-09-08 16:13:02 -0700561 int type, unsigned long cnt)
Minchan Kim248ca1b2015-04-15 16:15:42 -0700562{
Minchan Kim48b48002016-07-26 15:23:31 -0700563 class->stats.objs[type] -= cnt;
Minchan Kim248ca1b2015-04-15 16:15:42 -0700564}
565
Matthias Kaehlcke3eb95fe2017-09-08 16:13:02 -0700566/* type can be of enum type zs_stat_type or fullness_group */
Minchan Kim248ca1b2015-04-15 16:15:42 -0700567static inline unsigned long zs_stat_get(struct size_class *class,
Matthias Kaehlcke3eb95fe2017-09-08 16:13:02 -0700568 int type)
Minchan Kim248ca1b2015-04-15 16:15:42 -0700569{
Minchan Kim48b48002016-07-26 15:23:31 -0700570 return class->stats.objs[type];
Minchan Kim248ca1b2015-04-15 16:15:42 -0700571}
572
Sergey Senozhatsky57244592015-09-08 15:04:27 -0700573#ifdef CONFIG_ZSMALLOC_STAT
574
Dan Streetman4abaac92016-05-26 15:16:27 -0700575static void __init zs_stat_init(void)
Minchan Kim248ca1b2015-04-15 16:15:42 -0700576{
Dan Streetman4abaac92016-05-26 15:16:27 -0700577 if (!debugfs_initialized()) {
578 pr_warn("debugfs not available, stat dir not created\n");
579 return;
580 }
Minchan Kim248ca1b2015-04-15 16:15:42 -0700581
582 zs_stat_root = debugfs_create_dir("zsmalloc", NULL);
583 if (!zs_stat_root)
Dan Streetman4abaac92016-05-26 15:16:27 -0700584 pr_warn("debugfs 'zsmalloc' stat dir creation failed\n");
Minchan Kim248ca1b2015-04-15 16:15:42 -0700585}
586
587static void __exit zs_stat_exit(void)
588{
589 debugfs_remove_recursive(zs_stat_root);
590}
591
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700592static unsigned long zs_can_compact(struct size_class *class);
593
Minchan Kim248ca1b2015-04-15 16:15:42 -0700594static int zs_stats_size_show(struct seq_file *s, void *v)
595{
596 int i;
597 struct zs_pool *pool = s->private;
598 struct size_class *class;
599 int objs_per_zspage;
600 unsigned long class_almost_full, class_almost_empty;
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700601 unsigned long obj_allocated, obj_used, pages_used, freeable;
Minchan Kim248ca1b2015-04-15 16:15:42 -0700602 unsigned long total_class_almost_full = 0, total_class_almost_empty = 0;
603 unsigned long total_objs = 0, total_used_objs = 0, total_pages = 0;
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700604 unsigned long total_freeable = 0;
Minchan Kim248ca1b2015-04-15 16:15:42 -0700605
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700606 seq_printf(s, " %5s %5s %11s %12s %13s %10s %10s %16s %8s\n",
Minchan Kim248ca1b2015-04-15 16:15:42 -0700607 "class", "size", "almost_full", "almost_empty",
608 "obj_allocated", "obj_used", "pages_used",
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700609 "pages_per_zspage", "freeable");
Minchan Kim248ca1b2015-04-15 16:15:42 -0700610
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -0700611 for (i = 0; i < ZS_SIZE_CLASSES; i++) {
Minchan Kim248ca1b2015-04-15 16:15:42 -0700612 class = pool->size_class[i];
613
614 if (class->index != i)
615 continue;
616
617 spin_lock(&class->lock);
618 class_almost_full = zs_stat_get(class, CLASS_ALMOST_FULL);
619 class_almost_empty = zs_stat_get(class, CLASS_ALMOST_EMPTY);
620 obj_allocated = zs_stat_get(class, OBJ_ALLOCATED);
621 obj_used = zs_stat_get(class, OBJ_USED);
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700622 freeable = zs_can_compact(class);
Minchan Kim248ca1b2015-04-15 16:15:42 -0700623 spin_unlock(&class->lock);
624
Ganesh Mahendranb4fd07a2016-07-28 15:47:49 -0700625 objs_per_zspage = class->objs_per_zspage;
Minchan Kim248ca1b2015-04-15 16:15:42 -0700626 pages_used = obj_allocated / objs_per_zspage *
627 class->pages_per_zspage;
628
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700629 seq_printf(s, " %5u %5u %11lu %12lu %13lu"
630 " %10lu %10lu %16d %8lu\n",
Minchan Kim248ca1b2015-04-15 16:15:42 -0700631 i, class->size, class_almost_full, class_almost_empty,
632 obj_allocated, obj_used, pages_used,
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700633 class->pages_per_zspage, freeable);
Minchan Kim248ca1b2015-04-15 16:15:42 -0700634
635 total_class_almost_full += class_almost_full;
636 total_class_almost_empty += class_almost_empty;
637 total_objs += obj_allocated;
638 total_used_objs += obj_used;
639 total_pages += pages_used;
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700640 total_freeable += freeable;
Minchan Kim248ca1b2015-04-15 16:15:42 -0700641 }
642
643 seq_puts(s, "\n");
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700644 seq_printf(s, " %5s %5s %11lu %12lu %13lu %10lu %10lu %16s %8lu\n",
Minchan Kim248ca1b2015-04-15 16:15:42 -0700645 "Total", "", total_class_almost_full,
646 total_class_almost_empty, total_objs,
Sergey Senozhatsky1120ed52016-03-17 14:20:42 -0700647 total_used_objs, total_pages, "", total_freeable);
Minchan Kim248ca1b2015-04-15 16:15:42 -0700648
649 return 0;
650}
Andy Shevchenko5ad35092018-04-05 16:23:16 -0700651DEFINE_SHOW_ATTRIBUTE(zs_stats_size);
Minchan Kim248ca1b2015-04-15 16:15:42 -0700652
Dan Streetmand34f6152016-05-20 16:59:56 -0700653static void zs_pool_stat_create(struct zs_pool *pool, const char *name)
Minchan Kim248ca1b2015-04-15 16:15:42 -0700654{
655 struct dentry *entry;
656
Dan Streetman4abaac92016-05-26 15:16:27 -0700657 if (!zs_stat_root) {
658 pr_warn("no root stat dir, not creating <%s> stat dir\n", name);
Dan Streetmand34f6152016-05-20 16:59:56 -0700659 return;
Dan Streetman4abaac92016-05-26 15:16:27 -0700660 }
Minchan Kim248ca1b2015-04-15 16:15:42 -0700661
662 entry = debugfs_create_dir(name, zs_stat_root);
663 if (!entry) {
664 pr_warn("debugfs dir <%s> creation failed\n", name);
Dan Streetmand34f6152016-05-20 16:59:56 -0700665 return;
Minchan Kim248ca1b2015-04-15 16:15:42 -0700666 }
667 pool->stat_dentry = entry;
668
Joe Perches0825a6f2018-06-14 15:27:58 -0700669 entry = debugfs_create_file("classes", S_IFREG | 0444,
670 pool->stat_dentry, pool,
671 &zs_stats_size_fops);
Minchan Kim248ca1b2015-04-15 16:15:42 -0700672 if (!entry) {
673 pr_warn("%s: debugfs file entry <%s> creation failed\n",
674 name, "classes");
Dan Streetman4abaac92016-05-26 15:16:27 -0700675 debugfs_remove_recursive(pool->stat_dentry);
676 pool->stat_dentry = NULL;
Minchan Kim248ca1b2015-04-15 16:15:42 -0700677 }
Minchan Kim248ca1b2015-04-15 16:15:42 -0700678}
679
680static void zs_pool_stat_destroy(struct zs_pool *pool)
681{
682 debugfs_remove_recursive(pool->stat_dentry);
683}
684
685#else /* CONFIG_ZSMALLOC_STAT */
Dan Streetman4abaac92016-05-26 15:16:27 -0700686static void __init zs_stat_init(void)
Minchan Kim248ca1b2015-04-15 16:15:42 -0700687{
Minchan Kim248ca1b2015-04-15 16:15:42 -0700688}
689
690static void __exit zs_stat_exit(void)
691{
692}
693
Dan Streetmand34f6152016-05-20 16:59:56 -0700694static inline void zs_pool_stat_create(struct zs_pool *pool, const char *name)
Minchan Kim248ca1b2015-04-15 16:15:42 -0700695{
Minchan Kim248ca1b2015-04-15 16:15:42 -0700696}
697
698static inline void zs_pool_stat_destroy(struct zs_pool *pool)
699{
700}
Minchan Kim248ca1b2015-04-15 16:15:42 -0700701#endif
702
Minchan Kim48b48002016-07-26 15:23:31 -0700703
Nitin Cuptac3e3e882013-12-11 11:04:37 +0900704/*
705 * For each size class, zspages are divided into different groups
706 * depending on how "full" they are. This was done so that we could
707 * easily find empty or nearly empty zspages when we try to shrink
708 * the pool (not yet implemented). This function returns fullness
709 * status of the given page.
710 */
Minchan Kim1fc6e272016-07-26 15:23:11 -0700711static enum fullness_group get_fullness_group(struct size_class *class,
Minchan Kim37836892016-07-26 15:23:23 -0700712 struct zspage *zspage)
Nitin Gupta61989a82012-01-09 16:51:56 -0600713{
Minchan Kim1fc6e272016-07-26 15:23:11 -0700714 int inuse, objs_per_zspage;
Nitin Gupta61989a82012-01-09 16:51:56 -0600715 enum fullness_group fg;
Minchan Kim830e4bc2016-05-20 16:59:39 -0700716
Minchan Kim37836892016-07-26 15:23:23 -0700717 inuse = get_zspage_inuse(zspage);
Minchan Kim1fc6e272016-07-26 15:23:11 -0700718 objs_per_zspage = class->objs_per_zspage;
Nitin Gupta61989a82012-01-09 16:51:56 -0600719
720 if (inuse == 0)
721 fg = ZS_EMPTY;
Minchan Kim1fc6e272016-07-26 15:23:11 -0700722 else if (inuse == objs_per_zspage)
Nitin Gupta61989a82012-01-09 16:51:56 -0600723 fg = ZS_FULL;
Minchan Kim1fc6e272016-07-26 15:23:11 -0700724 else if (inuse <= 3 * objs_per_zspage / fullness_threshold_frac)
Nitin Gupta61989a82012-01-09 16:51:56 -0600725 fg = ZS_ALMOST_EMPTY;
726 else
727 fg = ZS_ALMOST_FULL;
728
729 return fg;
730}
731
Nitin Cuptac3e3e882013-12-11 11:04:37 +0900732/*
733 * Each size class maintains various freelists and zspages are assigned
734 * to one of these freelists based on the number of live objects they
735 * have. This functions inserts the given zspage into the freelist
736 * identified by <class, fullness_group>.
737 */
Minchan Kim251cbb92016-05-20 16:59:42 -0700738static void insert_zspage(struct size_class *class,
Minchan Kim37836892016-07-26 15:23:23 -0700739 struct zspage *zspage,
740 enum fullness_group fullness)
Nitin Gupta61989a82012-01-09 16:51:56 -0600741{
Minchan Kim37836892016-07-26 15:23:23 -0700742 struct zspage *head;
Nitin Gupta61989a82012-01-09 16:51:56 -0600743
Minchan Kim48b48002016-07-26 15:23:31 -0700744 zs_stat_inc(class, fullness, 1);
Minchan Kim37836892016-07-26 15:23:23 -0700745 head = list_first_entry_or_null(&class->fullness_list[fullness],
746 struct zspage, list);
Sergey Senozhatsky58f17112015-09-08 15:04:44 -0700747 /*
Minchan Kim37836892016-07-26 15:23:23 -0700748 * We want to see more ZS_FULL pages and less almost empty/full.
749 * Put pages with higher ->inuse first.
Sergey Senozhatsky58f17112015-09-08 15:04:44 -0700750 */
Minchan Kim37836892016-07-26 15:23:23 -0700751 if (head) {
752 if (get_zspage_inuse(zspage) < get_zspage_inuse(head)) {
753 list_add(&zspage->list, &head->list);
754 return;
755 }
756 }
757 list_add(&zspage->list, &class->fullness_list[fullness]);
Nitin Gupta61989a82012-01-09 16:51:56 -0600758}
759
Nitin Cuptac3e3e882013-12-11 11:04:37 +0900760/*
761 * This function removes the given zspage from the freelist identified
762 * by <class, fullness_group>.
763 */
Minchan Kim251cbb92016-05-20 16:59:42 -0700764static void remove_zspage(struct size_class *class,
Minchan Kim37836892016-07-26 15:23:23 -0700765 struct zspage *zspage,
766 enum fullness_group fullness)
Nitin Gupta61989a82012-01-09 16:51:56 -0600767{
Minchan Kim37836892016-07-26 15:23:23 -0700768 VM_BUG_ON(list_empty(&class->fullness_list[fullness]));
Minchan Kim48b48002016-07-26 15:23:31 -0700769 VM_BUG_ON(is_zspage_isolated(zspage));
Nitin Gupta61989a82012-01-09 16:51:56 -0600770
Minchan Kim37836892016-07-26 15:23:23 -0700771 list_del_init(&zspage->list);
Minchan Kim48b48002016-07-26 15:23:31 -0700772 zs_stat_dec(class, fullness, 1);
Nitin Gupta61989a82012-01-09 16:51:56 -0600773}
774
Nitin Cuptac3e3e882013-12-11 11:04:37 +0900775/*
776 * Each size class maintains zspages in different fullness groups depending
777 * on the number of live objects they contain. When allocating or freeing
778 * objects, the fullness status of the page can change, say, from ALMOST_FULL
779 * to ALMOST_EMPTY when freeing an object. This function checks if such
780 * a status change has occurred for the given page and accordingly moves the
781 * page from the freelist of the old fullness group to that of the new
782 * fullness group.
783 */
Minchan Kimc7806262015-04-15 16:15:26 -0700784static enum fullness_group fix_fullness_group(struct size_class *class,
Minchan Kim37836892016-07-26 15:23:23 -0700785 struct zspage *zspage)
Nitin Gupta61989a82012-01-09 16:51:56 -0600786{
787 int class_idx;
Nitin Gupta61989a82012-01-09 16:51:56 -0600788 enum fullness_group currfg, newfg;
789
Minchan Kim37836892016-07-26 15:23:23 -0700790 get_zspage_mapping(zspage, &class_idx, &currfg);
791 newfg = get_fullness_group(class, zspage);
Nitin Gupta61989a82012-01-09 16:51:56 -0600792 if (newfg == currfg)
793 goto out;
794
Minchan Kim48b48002016-07-26 15:23:31 -0700795 if (!is_zspage_isolated(zspage)) {
796 remove_zspage(class, zspage, currfg);
797 insert_zspage(class, zspage, newfg);
798 }
799
Minchan Kim37836892016-07-26 15:23:23 -0700800 set_zspage_mapping(zspage, class_idx, newfg);
Nitin Gupta61989a82012-01-09 16:51:56 -0600801
802out:
803 return newfg;
804}
805
806/*
807 * We have to decide on how many pages to link together
808 * to form a zspage for each size class. This is important
809 * to reduce wastage due to unusable space left at end of
810 * each zspage which is given as:
Yinghao Xie888fa3742015-04-15 16:15:49 -0700811 * wastage = Zp % class_size
812 * usage = Zp - wastage
Nitin Gupta61989a82012-01-09 16:51:56 -0600813 * where Zp = zspage size = k * PAGE_SIZE where k = 1, 2, ...
814 *
815 * For example, for size class of 3/8 * PAGE_SIZE, we should
816 * link together 3 PAGE_SIZE sized pages to form a zspage
817 * since then we can perfectly fit in 8 such objects.
818 */
Minchan Kim2e3b61542012-05-03 15:40:39 +0900819static int get_pages_per_zspage(int class_size)
Nitin Gupta61989a82012-01-09 16:51:56 -0600820{
821 int i, max_usedpc = 0;
822 /* zspage order which gives maximum used size per KB */
823 int max_usedpc_order = 1;
824
Seth Jennings84d4faa2012-03-05 11:33:21 -0600825 for (i = 1; i <= ZS_MAX_PAGES_PER_ZSPAGE; i++) {
Nitin Gupta61989a82012-01-09 16:51:56 -0600826 int zspage_size;
827 int waste, usedpc;
828
829 zspage_size = i * PAGE_SIZE;
830 waste = zspage_size % class_size;
831 usedpc = (zspage_size - waste) * 100 / zspage_size;
832
833 if (usedpc > max_usedpc) {
834 max_usedpc = usedpc;
835 max_usedpc_order = i;
836 }
837 }
838
839 return max_usedpc_order;
840}
841
Minchan Kim37836892016-07-26 15:23:23 -0700842static struct zspage *get_zspage(struct page *page)
Nitin Gupta61989a82012-01-09 16:51:56 -0600843{
Minchan Kim48b48002016-07-26 15:23:31 -0700844 struct zspage *zspage = (struct zspage *)page->private;
845
846 BUG_ON(zspage->magic != ZSPAGE_MAGIC);
847 return zspage;
Nitin Gupta61989a82012-01-09 16:51:56 -0600848}
849
850static struct page *get_next_page(struct page *page)
851{
Minchan Kim48b48002016-07-26 15:23:31 -0700852 if (unlikely(PageHugeObject(page)))
853 return NULL;
854
855 return page->freelist;
Nitin Gupta61989a82012-01-09 16:51:56 -0600856}
857
Minchan Kimbfd093f2016-07-26 15:23:28 -0700858/**
859 * obj_to_location - get (<page>, <obj_idx>) from encoded object value
Mike Rapoporte8b098f2018-04-05 16:24:57 -0700860 * @obj: the encoded object value
Minchan Kimbfd093f2016-07-26 15:23:28 -0700861 * @page: page object resides in zspage
862 * @obj_idx: object index
Olav Haugan67296872013-11-22 09:30:41 -0800863 */
Minchan Kim312fcae2015-04-15 16:15:30 -0700864static void obj_to_location(unsigned long obj, struct page **page,
Minchan Kimbfd093f2016-07-26 15:23:28 -0700865 unsigned int *obj_idx)
Nitin Gupta61989a82012-01-09 16:51:56 -0600866{
Minchan Kim312fcae2015-04-15 16:15:30 -0700867 obj >>= OBJ_TAG_BITS;
868 *page = pfn_to_page(obj >> OBJ_INDEX_BITS);
869 *obj_idx = (obj & OBJ_INDEX_MASK);
Nitin Gupta61989a82012-01-09 16:51:56 -0600870}
871
Minchan Kimbfd093f2016-07-26 15:23:28 -0700872/**
873 * location_to_obj - get obj value encoded from (<page>, <obj_idx>)
874 * @page: page object resides in zspage
875 * @obj_idx: object index
876 */
877static unsigned long location_to_obj(struct page *page, unsigned int obj_idx)
878{
879 unsigned long obj;
880
881 obj = page_to_pfn(page) << OBJ_INDEX_BITS;
882 obj |= obj_idx & OBJ_INDEX_MASK;
883 obj <<= OBJ_TAG_BITS;
884
885 return obj;
886}
887
Minchan Kim2e40e162015-04-15 16:15:23 -0700888static unsigned long handle_to_obj(unsigned long handle)
889{
890 return *(unsigned long *)handle;
891}
892
Minchan Kim48b48002016-07-26 15:23:31 -0700893static unsigned long obj_to_head(struct page *page, void *obj)
Minchan Kim312fcae2015-04-15 16:15:30 -0700894{
Minchan Kim48b48002016-07-26 15:23:31 -0700895 if (unlikely(PageHugeObject(page))) {
Minchan Kim830e4bc2016-05-20 16:59:39 -0700896 VM_BUG_ON_PAGE(!is_first_page(page), page);
Minchan Kim37836892016-07-26 15:23:23 -0700897 return page->index;
Minchan Kim7b60a682015-04-15 16:15:39 -0700898 } else
899 return *(unsigned long *)obj;
Minchan Kim312fcae2015-04-15 16:15:30 -0700900}
901
Minchan Kim48b48002016-07-26 15:23:31 -0700902static inline int testpin_tag(unsigned long handle)
903{
904 return bit_spin_is_locked(HANDLE_PIN_BIT, (unsigned long *)handle);
905}
906
Minchan Kim312fcae2015-04-15 16:15:30 -0700907static inline int trypin_tag(unsigned long handle)
908{
Minchan Kim1b8320b2016-07-26 15:23:14 -0700909 return bit_spin_trylock(HANDLE_PIN_BIT, (unsigned long *)handle);
Minchan Kim312fcae2015-04-15 16:15:30 -0700910}
911
912static void pin_tag(unsigned long handle)
913{
Minchan Kim1b8320b2016-07-26 15:23:14 -0700914 bit_spin_lock(HANDLE_PIN_BIT, (unsigned long *)handle);
Minchan Kim312fcae2015-04-15 16:15:30 -0700915}
916
917static void unpin_tag(unsigned long handle)
918{
Minchan Kim1b8320b2016-07-26 15:23:14 -0700919 bit_spin_unlock(HANDLE_PIN_BIT, (unsigned long *)handle);
Minchan Kim312fcae2015-04-15 16:15:30 -0700920}
921
Nitin Guptaf4477e92012-04-02 09:13:56 -0500922static void reset_page(struct page *page)
923{
Minchan Kim48b48002016-07-26 15:23:31 -0700924 __ClearPageMovable(page);
Ganesh Mahendran18fd06b2016-07-28 15:48:00 -0700925 ClearPagePrivate(page);
Nitin Guptaf4477e92012-04-02 09:13:56 -0500926 set_page_private(page, 0);
Minchan Kim48b48002016-07-26 15:23:31 -0700927 page_mapcount_reset(page);
928 ClearPageHugeObject(page);
929 page->freelist = NULL;
Nitin Guptaf4477e92012-04-02 09:13:56 -0500930}
931
Colin Ian King4d0a5402018-08-17 15:46:50 -0700932static int trylock_zspage(struct zspage *zspage)
Minchan Kim48b48002016-07-26 15:23:31 -0700933{
934 struct page *cursor, *fail;
935
936 for (cursor = get_first_page(zspage); cursor != NULL; cursor =
937 get_next_page(cursor)) {
938 if (!trylock_page(cursor)) {
939 fail = cursor;
940 goto unlock;
941 }
942 }
943
944 return 1;
945unlock:
946 for (cursor = get_first_page(zspage); cursor != fail; cursor =
947 get_next_page(cursor))
948 unlock_page(cursor);
949
950 return 0;
951}
952
953static void __free_zspage(struct zs_pool *pool, struct size_class *class,
954 struct zspage *zspage)
Nitin Gupta61989a82012-01-09 16:51:56 -0600955{
Minchan Kim37836892016-07-26 15:23:23 -0700956 struct page *page, *next;
Minchan Kim48b48002016-07-26 15:23:31 -0700957 enum fullness_group fg;
958 unsigned int class_idx;
959
960 get_zspage_mapping(zspage, &class_idx, &fg);
961
962 assert_spin_locked(&class->lock);
Nitin Gupta61989a82012-01-09 16:51:56 -0600963
Minchan Kim37836892016-07-26 15:23:23 -0700964 VM_BUG_ON(get_zspage_inuse(zspage));
Minchan Kim48b48002016-07-26 15:23:31 -0700965 VM_BUG_ON(fg != ZS_EMPTY);
Nitin Gupta61989a82012-01-09 16:51:56 -0600966
Minchan Kim48b48002016-07-26 15:23:31 -0700967 next = page = get_first_page(zspage);
Minchan Kim37836892016-07-26 15:23:23 -0700968 do {
Minchan Kim48b48002016-07-26 15:23:31 -0700969 VM_BUG_ON_PAGE(!PageLocked(page), page);
970 next = get_next_page(page);
Minchan Kim37836892016-07-26 15:23:23 -0700971 reset_page(page);
Minchan Kim48b48002016-07-26 15:23:31 -0700972 unlock_page(page);
Minchan Kim91537fe2016-07-26 15:24:45 -0700973 dec_zone_page_state(page, NR_ZSPAGES);
Minchan Kim37836892016-07-26 15:23:23 -0700974 put_page(page);
975 page = next;
976 } while (page != NULL);
Nitin Gupta61989a82012-01-09 16:51:56 -0600977
Minchan Kim37836892016-07-26 15:23:23 -0700978 cache_free_zspage(pool, zspage);
Minchan Kim48b48002016-07-26 15:23:31 -0700979
Ganesh Mahendranb4fd07a2016-07-28 15:47:49 -0700980 zs_stat_dec(class, OBJ_ALLOCATED, class->objs_per_zspage);
Minchan Kim48b48002016-07-26 15:23:31 -0700981 atomic_long_sub(class->pages_per_zspage,
982 &pool->pages_allocated);
983}
984
985static void free_zspage(struct zs_pool *pool, struct size_class *class,
986 struct zspage *zspage)
987{
988 VM_BUG_ON(get_zspage_inuse(zspage));
989 VM_BUG_ON(list_empty(&zspage->list));
990
991 if (!trylock_zspage(zspage)) {
992 kick_deferred_free(pool);
993 return;
994 }
995
996 remove_zspage(class, zspage, ZS_EMPTY);
997 __free_zspage(pool, class, zspage);
Nitin Gupta61989a82012-01-09 16:51:56 -0600998}
999
1000/* Initialize a newly allocated zspage */
Minchan Kim37836892016-07-26 15:23:23 -07001001static void init_zspage(struct size_class *class, struct zspage *zspage)
Nitin Gupta61989a82012-01-09 16:51:56 -06001002{
Minchan Kimbfd093f2016-07-26 15:23:28 -07001003 unsigned int freeobj = 1;
Nitin Gupta61989a82012-01-09 16:51:56 -06001004 unsigned long off = 0;
Minchan Kim48b48002016-07-26 15:23:31 -07001005 struct page *page = get_first_page(zspage);
Minchan Kim830e4bc2016-05-20 16:59:39 -07001006
Nitin Gupta61989a82012-01-09 16:51:56 -06001007 while (page) {
1008 struct page *next_page;
1009 struct link_free *link;
Minchan Kimaf4ee5e2014-12-12 16:56:58 -08001010 void *vaddr;
Nitin Gupta61989a82012-01-09 16:51:56 -06001011
Minchan Kim37836892016-07-26 15:23:23 -07001012 set_first_obj_offset(page, off);
Nitin Gupta61989a82012-01-09 16:51:56 -06001013
Minchan Kimaf4ee5e2014-12-12 16:56:58 -08001014 vaddr = kmap_atomic(page);
1015 link = (struct link_free *)vaddr + off / sizeof(*link);
Nitin Gupta61989a82012-01-09 16:51:56 -06001016
Dan Streetman5538c562014-10-09 15:30:01 -07001017 while ((off += class->size) < PAGE_SIZE) {
Minchan Kim3b1d9ca2016-07-26 15:23:37 -07001018 link->next = freeobj++ << OBJ_TAG_BITS;
Dan Streetman5538c562014-10-09 15:30:01 -07001019 link += class->size / sizeof(*link);
Nitin Gupta61989a82012-01-09 16:51:56 -06001020 }
1021
1022 /*
1023 * We now come to the last (full or partial) object on this
1024 * page, which must point to the first object on the next
1025 * page (if present)
1026 */
1027 next_page = get_next_page(page);
Minchan Kimbfd093f2016-07-26 15:23:28 -07001028 if (next_page) {
Minchan Kim3b1d9ca2016-07-26 15:23:37 -07001029 link->next = freeobj++ << OBJ_TAG_BITS;
Minchan Kimbfd093f2016-07-26 15:23:28 -07001030 } else {
1031 /*
Minchan Kim3b1d9ca2016-07-26 15:23:37 -07001032 * Reset OBJ_TAG_BITS bit to last link to tell
Minchan Kimbfd093f2016-07-26 15:23:28 -07001033 * whether it's allocated object or not.
1034 */
Nick Desaulniers01a6ad92018-01-31 16:20:15 -08001035 link->next = -1UL << OBJ_TAG_BITS;
Minchan Kimbfd093f2016-07-26 15:23:28 -07001036 }
Minchan Kimaf4ee5e2014-12-12 16:56:58 -08001037 kunmap_atomic(vaddr);
Nitin Gupta61989a82012-01-09 16:51:56 -06001038 page = next_page;
Dan Streetman5538c562014-10-09 15:30:01 -07001039 off %= PAGE_SIZE;
Nitin Gupta61989a82012-01-09 16:51:56 -06001040 }
Minchan Kimbdb0af72016-07-26 15:23:20 -07001041
Minchan Kimbfd093f2016-07-26 15:23:28 -07001042 set_freeobj(zspage, 0);
Nitin Gupta61989a82012-01-09 16:51:56 -06001043}
1044
Minchan Kim48b48002016-07-26 15:23:31 -07001045static void create_page_chain(struct size_class *class, struct zspage *zspage,
1046 struct page *pages[])
Nitin Gupta61989a82012-01-09 16:51:56 -06001047{
Minchan Kimbdb0af72016-07-26 15:23:20 -07001048 int i;
1049 struct page *page;
1050 struct page *prev_page = NULL;
Minchan Kim48b48002016-07-26 15:23:31 -07001051 int nr_pages = class->pages_per_zspage;
Nitin Gupta61989a82012-01-09 16:51:56 -06001052
1053 /*
1054 * Allocate individual pages and link them together as:
Minchan Kim48b48002016-07-26 15:23:31 -07001055 * 1. all pages are linked together using page->freelist
Minchan Kim37836892016-07-26 15:23:23 -07001056 * 2. each sub-page point to zspage using page->private
Nitin Gupta61989a82012-01-09 16:51:56 -06001057 *
Minchan Kim37836892016-07-26 15:23:23 -07001058 * we set PG_private to identify the first page (i.e. no other sub-page
Yisheng Xie22c5cef2017-02-24 14:59:42 -08001059 * has this flag set).
Nitin Gupta61989a82012-01-09 16:51:56 -06001060 */
Minchan Kimbdb0af72016-07-26 15:23:20 -07001061 for (i = 0; i < nr_pages; i++) {
1062 page = pages[i];
Minchan Kim37836892016-07-26 15:23:23 -07001063 set_page_private(page, (unsigned long)zspage);
Minchan Kim48b48002016-07-26 15:23:31 -07001064 page->freelist = NULL;
Minchan Kimbdb0af72016-07-26 15:23:20 -07001065 if (i == 0) {
Minchan Kim37836892016-07-26 15:23:23 -07001066 zspage->first_page = page;
Minchan Kima27545bf2012-04-25 15:23:09 +09001067 SetPagePrivate(page);
Minchan Kim48b48002016-07-26 15:23:31 -07001068 if (unlikely(class->objs_per_zspage == 1 &&
1069 class->pages_per_zspage == 1))
1070 SetPageHugeObject(page);
Minchan Kim37836892016-07-26 15:23:23 -07001071 } else {
Minchan Kim48b48002016-07-26 15:23:31 -07001072 prev_page->freelist = page;
Nitin Gupta61989a82012-01-09 16:51:56 -06001073 }
Nitin Gupta61989a82012-01-09 16:51:56 -06001074 prev_page = page;
1075 }
Minchan Kimbdb0af72016-07-26 15:23:20 -07001076}
Nitin Gupta61989a82012-01-09 16:51:56 -06001077
Minchan Kimbdb0af72016-07-26 15:23:20 -07001078/*
1079 * Allocate a zspage for the given size class
1080 */
Minchan Kim37836892016-07-26 15:23:23 -07001081static struct zspage *alloc_zspage(struct zs_pool *pool,
1082 struct size_class *class,
1083 gfp_t gfp)
Minchan Kimbdb0af72016-07-26 15:23:20 -07001084{
1085 int i;
Minchan Kimbdb0af72016-07-26 15:23:20 -07001086 struct page *pages[ZS_MAX_PAGES_PER_ZSPAGE];
Minchan Kim37836892016-07-26 15:23:23 -07001087 struct zspage *zspage = cache_alloc_zspage(pool, gfp);
1088
1089 if (!zspage)
1090 return NULL;
1091
1092 memset(zspage, 0, sizeof(struct zspage));
Minchan Kim48b48002016-07-26 15:23:31 -07001093 zspage->magic = ZSPAGE_MAGIC;
1094 migrate_lock_init(zspage);
Nitin Gupta61989a82012-01-09 16:51:56 -06001095
Minchan Kimbdb0af72016-07-26 15:23:20 -07001096 for (i = 0; i < class->pages_per_zspage; i++) {
1097 struct page *page;
Nitin Gupta61989a82012-01-09 16:51:56 -06001098
Minchan Kim37836892016-07-26 15:23:23 -07001099 page = alloc_page(gfp);
Minchan Kimbdb0af72016-07-26 15:23:20 -07001100 if (!page) {
Minchan Kim91537fe2016-07-26 15:24:45 -07001101 while (--i >= 0) {
1102 dec_zone_page_state(pages[i], NR_ZSPAGES);
Minchan Kimbdb0af72016-07-26 15:23:20 -07001103 __free_page(pages[i]);
Minchan Kim91537fe2016-07-26 15:24:45 -07001104 }
Minchan Kim37836892016-07-26 15:23:23 -07001105 cache_free_zspage(pool, zspage);
Minchan Kimbdb0af72016-07-26 15:23:20 -07001106 return NULL;
1107 }
Minchan Kim91537fe2016-07-26 15:24:45 -07001108
1109 inc_zone_page_state(page, NR_ZSPAGES);
Minchan Kimbdb0af72016-07-26 15:23:20 -07001110 pages[i] = page;
Nitin Gupta61989a82012-01-09 16:51:56 -06001111 }
1112
Minchan Kim48b48002016-07-26 15:23:31 -07001113 create_page_chain(class, zspage, pages);
Minchan Kim37836892016-07-26 15:23:23 -07001114 init_zspage(class, zspage);
Minchan Kimbdb0af72016-07-26 15:23:20 -07001115
Minchan Kim37836892016-07-26 15:23:23 -07001116 return zspage;
Nitin Gupta61989a82012-01-09 16:51:56 -06001117}
1118
Minchan Kim37836892016-07-26 15:23:23 -07001119static struct zspage *find_get_zspage(struct size_class *class)
Nitin Gupta61989a82012-01-09 16:51:56 -06001120{
1121 int i;
Minchan Kim37836892016-07-26 15:23:23 -07001122 struct zspage *zspage;
Nitin Gupta61989a82012-01-09 16:51:56 -06001123
Minchan Kim48b48002016-07-26 15:23:31 -07001124 for (i = ZS_ALMOST_FULL; i >= ZS_EMPTY; i--) {
Minchan Kim37836892016-07-26 15:23:23 -07001125 zspage = list_first_entry_or_null(&class->fullness_list[i],
1126 struct zspage, list);
1127 if (zspage)
Nitin Gupta61989a82012-01-09 16:51:56 -06001128 break;
1129 }
1130
Minchan Kim37836892016-07-26 15:23:23 -07001131 return zspage;
Nitin Gupta61989a82012-01-09 16:51:56 -06001132}
1133
Minchan Kim1b945ae2013-12-11 11:04:36 +09001134#ifdef CONFIG_PGTABLE_MAPPING
Seth Jenningsf5536462012-07-18 11:55:56 -05001135static inline int __zs_cpu_up(struct mapping_area *area)
Seth Jennings5f601902012-07-02 16:15:49 -05001136{
Seth Jenningsf5536462012-07-18 11:55:56 -05001137 /*
1138 * Make sure we don't leak memory if a cpu UP notification
1139 * and zs_init() race and both call zs_cpu_up() on the same cpu
1140 */
1141 if (area->vm)
1142 return 0;
1143 area->vm = alloc_vm_area(PAGE_SIZE * 2, NULL);
1144 if (!area->vm)
1145 return -ENOMEM;
1146 return 0;
1147}
1148
1149static inline void __zs_cpu_down(struct mapping_area *area)
1150{
1151 if (area->vm)
1152 free_vm_area(area->vm);
1153 area->vm = NULL;
1154}
1155
1156static inline void *__zs_map_object(struct mapping_area *area,
1157 struct page *pages[2], int off, int size)
1158{
WANG Chaof6f8ed42014-08-06 16:06:58 -07001159 BUG_ON(map_vm_area(area->vm, PAGE_KERNEL, pages));
Seth Jenningsf5536462012-07-18 11:55:56 -05001160 area->vm_addr = area->vm->addr;
1161 return area->vm_addr + off;
1162}
1163
1164static inline void __zs_unmap_object(struct mapping_area *area,
1165 struct page *pages[2], int off, int size)
1166{
1167 unsigned long addr = (unsigned long)area->vm_addr;
Seth Jenningsf5536462012-07-18 11:55:56 -05001168
Joerg Roedeld95abbb2013-03-27 01:43:14 +01001169 unmap_kernel_range(addr, PAGE_SIZE * 2);
Seth Jenningsf5536462012-07-18 11:55:56 -05001170}
1171
Minchan Kim1b945ae2013-12-11 11:04:36 +09001172#else /* CONFIG_PGTABLE_MAPPING */
Seth Jenningsf5536462012-07-18 11:55:56 -05001173
1174static inline int __zs_cpu_up(struct mapping_area *area)
1175{
1176 /*
1177 * Make sure we don't leak memory if a cpu UP notification
1178 * and zs_init() race and both call zs_cpu_up() on the same cpu
1179 */
1180 if (area->vm_buf)
1181 return 0;
Mahendran Ganesh40f9fb82014-12-12 16:57:01 -08001182 area->vm_buf = kmalloc(ZS_MAX_ALLOC_SIZE, GFP_KERNEL);
Seth Jenningsf5536462012-07-18 11:55:56 -05001183 if (!area->vm_buf)
1184 return -ENOMEM;
1185 return 0;
1186}
1187
1188static inline void __zs_cpu_down(struct mapping_area *area)
1189{
Mahendran Ganesh40f9fb82014-12-12 16:57:01 -08001190 kfree(area->vm_buf);
Seth Jenningsf5536462012-07-18 11:55:56 -05001191 area->vm_buf = NULL;
1192}
1193
1194static void *__zs_map_object(struct mapping_area *area,
1195 struct page *pages[2], int off, int size)
1196{
Seth Jennings5f601902012-07-02 16:15:49 -05001197 int sizes[2];
1198 void *addr;
Seth Jenningsf5536462012-07-18 11:55:56 -05001199 char *buf = area->vm_buf;
Seth Jennings5f601902012-07-02 16:15:49 -05001200
Seth Jenningsf5536462012-07-18 11:55:56 -05001201 /* disable page faults to match kmap_atomic() return conditions */
1202 pagefault_disable();
1203
1204 /* no read fastpath */
1205 if (area->vm_mm == ZS_MM_WO)
1206 goto out;
Seth Jennings5f601902012-07-02 16:15:49 -05001207
1208 sizes[0] = PAGE_SIZE - off;
1209 sizes[1] = size - sizes[0];
1210
Seth Jennings5f601902012-07-02 16:15:49 -05001211 /* copy object to per-cpu buffer */
1212 addr = kmap_atomic(pages[0]);
1213 memcpy(buf, addr + off, sizes[0]);
1214 kunmap_atomic(addr);
1215 addr = kmap_atomic(pages[1]);
1216 memcpy(buf + sizes[0], addr, sizes[1]);
1217 kunmap_atomic(addr);
Seth Jenningsf5536462012-07-18 11:55:56 -05001218out:
1219 return area->vm_buf;
Seth Jennings5f601902012-07-02 16:15:49 -05001220}
1221
Seth Jenningsf5536462012-07-18 11:55:56 -05001222static void __zs_unmap_object(struct mapping_area *area,
1223 struct page *pages[2], int off, int size)
Seth Jennings5f601902012-07-02 16:15:49 -05001224{
Seth Jennings5f601902012-07-02 16:15:49 -05001225 int sizes[2];
1226 void *addr;
Minchan Kim2e40e162015-04-15 16:15:23 -07001227 char *buf;
Seth Jennings5f601902012-07-02 16:15:49 -05001228
Seth Jenningsf5536462012-07-18 11:55:56 -05001229 /* no write fastpath */
1230 if (area->vm_mm == ZS_MM_RO)
1231 goto out;
Seth Jennings5f601902012-07-02 16:15:49 -05001232
Minchan Kim7b60a682015-04-15 16:15:39 -07001233 buf = area->vm_buf;
YiPing Xua82cbf02016-03-17 14:20:39 -07001234 buf = buf + ZS_HANDLE_SIZE;
1235 size -= ZS_HANDLE_SIZE;
1236 off += ZS_HANDLE_SIZE;
Minchan Kim2e40e162015-04-15 16:15:23 -07001237
Seth Jennings5f601902012-07-02 16:15:49 -05001238 sizes[0] = PAGE_SIZE - off;
1239 sizes[1] = size - sizes[0];
1240
1241 /* copy per-cpu buffer to object */
1242 addr = kmap_atomic(pages[0]);
1243 memcpy(addr + off, buf, sizes[0]);
1244 kunmap_atomic(addr);
1245 addr = kmap_atomic(pages[1]);
1246 memcpy(addr, buf + sizes[0], sizes[1]);
1247 kunmap_atomic(addr);
Seth Jenningsf5536462012-07-18 11:55:56 -05001248
1249out:
1250 /* enable page faults to match kunmap_atomic() return conditions */
1251 pagefault_enable();
Seth Jennings5f601902012-07-02 16:15:49 -05001252}
Nitin Gupta61989a82012-01-09 16:51:56 -06001253
Minchan Kim1b945ae2013-12-11 11:04:36 +09001254#endif /* CONFIG_PGTABLE_MAPPING */
Seth Jenningsf5536462012-07-18 11:55:56 -05001255
Sebastian Andrzej Siewior215c89d2016-11-27 00:13:38 +01001256static int zs_cpu_prepare(unsigned int cpu)
Nitin Gupta61989a82012-01-09 16:51:56 -06001257{
Nitin Gupta61989a82012-01-09 16:51:56 -06001258 struct mapping_area *area;
1259
Sebastian Andrzej Siewior215c89d2016-11-27 00:13:38 +01001260 area = &per_cpu(zs_map_area, cpu);
1261 return __zs_cpu_up(area);
Nitin Gupta61989a82012-01-09 16:51:56 -06001262}
1263
Sebastian Andrzej Siewior215c89d2016-11-27 00:13:38 +01001264static int zs_cpu_dead(unsigned int cpu)
Nitin Gupta61989a82012-01-09 16:51:56 -06001265{
Sebastian Andrzej Siewior215c89d2016-11-27 00:13:38 +01001266 struct mapping_area *area;
Nitin Gupta61989a82012-01-09 16:51:56 -06001267
Sebastian Andrzej Siewior215c89d2016-11-27 00:13:38 +01001268 area = &per_cpu(zs_map_area, cpu);
1269 __zs_cpu_down(area);
1270 return 0;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001271}
1272
Ganesh Mahendran64d90462016-07-28 15:47:51 -07001273static bool can_merge(struct size_class *prev, int pages_per_zspage,
1274 int objs_per_zspage)
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08001275{
Ganesh Mahendran64d90462016-07-28 15:47:51 -07001276 if (prev->pages_per_zspage == pages_per_zspage &&
1277 prev->objs_per_zspage == objs_per_zspage)
1278 return true;
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08001279
Ganesh Mahendran64d90462016-07-28 15:47:51 -07001280 return false;
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08001281}
1282
Minchan Kim37836892016-07-26 15:23:23 -07001283static bool zspage_full(struct size_class *class, struct zspage *zspage)
Minchan Kim312fcae2015-04-15 16:15:30 -07001284{
Minchan Kim37836892016-07-26 15:23:23 -07001285 return get_zspage_inuse(zspage) == class->objs_per_zspage;
Minchan Kim312fcae2015-04-15 16:15:30 -07001286}
1287
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001288unsigned long zs_get_total_pages(struct zs_pool *pool)
1289{
1290 return atomic_long_read(&pool->pages_allocated);
1291}
1292EXPORT_SYMBOL_GPL(zs_get_total_pages);
1293
1294/**
1295 * zs_map_object - get address of allocated object from handle.
1296 * @pool: pool from which the object was allocated
1297 * @handle: handle returned from zs_malloc
Mike Rapoporte8b098f2018-04-05 16:24:57 -07001298 * @mm: maping mode to use
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001299 *
1300 * Before using an object allocated from zs_malloc, it must be mapped using
1301 * this function. When done with the object, it must be unmapped using
1302 * zs_unmap_object.
1303 *
1304 * Only one object can be mapped per cpu at a time. There is no protection
1305 * against nested mappings.
1306 *
1307 * This function returns with preemption and page faults disabled.
1308 */
1309void *zs_map_object(struct zs_pool *pool, unsigned long handle,
1310 enum zs_mapmode mm)
1311{
Minchan Kim37836892016-07-26 15:23:23 -07001312 struct zspage *zspage;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001313 struct page *page;
Minchan Kimbfd093f2016-07-26 15:23:28 -07001314 unsigned long obj, off;
1315 unsigned int obj_idx;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001316
1317 unsigned int class_idx;
1318 enum fullness_group fg;
1319 struct size_class *class;
1320 struct mapping_area *area;
1321 struct page *pages[2];
Minchan Kim2e40e162015-04-15 16:15:23 -07001322 void *ret;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001323
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001324 /*
1325 * Because we use per-cpu mapping areas shared among the
1326 * pools/users, we can't allow mapping in interrupt context
1327 * because it can corrupt another users mappings.
1328 */
Sergey Senozhatsky1aedcaf2017-11-15 17:34:03 -08001329 BUG_ON(in_interrupt());
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001330
Minchan Kim312fcae2015-04-15 16:15:30 -07001331 /* From now on, migration cannot move the object */
1332 pin_tag(handle);
1333
Minchan Kim2e40e162015-04-15 16:15:23 -07001334 obj = handle_to_obj(handle);
1335 obj_to_location(obj, &page, &obj_idx);
Minchan Kim37836892016-07-26 15:23:23 -07001336 zspage = get_zspage(page);
Minchan Kim48b48002016-07-26 15:23:31 -07001337
1338 /* migration cannot move any subpage in this zspage */
1339 migrate_read_lock(zspage);
1340
Minchan Kim37836892016-07-26 15:23:23 -07001341 get_zspage_mapping(zspage, &class_idx, &fg);
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001342 class = pool->size_class[class_idx];
Minchan Kimbfd093f2016-07-26 15:23:28 -07001343 off = (class->size * obj_idx) & ~PAGE_MASK;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001344
1345 area = &get_cpu_var(zs_map_area);
1346 area->vm_mm = mm;
1347 if (off + class->size <= PAGE_SIZE) {
1348 /* this object is contained entirely within a page */
1349 area->vm_addr = kmap_atomic(page);
Minchan Kim2e40e162015-04-15 16:15:23 -07001350 ret = area->vm_addr + off;
1351 goto out;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001352 }
1353
1354 /* this object spans two pages */
1355 pages[0] = page;
1356 pages[1] = get_next_page(page);
1357 BUG_ON(!pages[1]);
1358
Minchan Kim2e40e162015-04-15 16:15:23 -07001359 ret = __zs_map_object(area, pages, off, class->size);
1360out:
Minchan Kim48b48002016-07-26 15:23:31 -07001361 if (likely(!PageHugeObject(page)))
Minchan Kim7b60a682015-04-15 16:15:39 -07001362 ret += ZS_HANDLE_SIZE;
1363
1364 return ret;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001365}
1366EXPORT_SYMBOL_GPL(zs_map_object);
1367
1368void zs_unmap_object(struct zs_pool *pool, unsigned long handle)
1369{
Minchan Kim37836892016-07-26 15:23:23 -07001370 struct zspage *zspage;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001371 struct page *page;
Minchan Kimbfd093f2016-07-26 15:23:28 -07001372 unsigned long obj, off;
1373 unsigned int obj_idx;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001374
1375 unsigned int class_idx;
1376 enum fullness_group fg;
1377 struct size_class *class;
1378 struct mapping_area *area;
1379
Minchan Kim2e40e162015-04-15 16:15:23 -07001380 obj = handle_to_obj(handle);
1381 obj_to_location(obj, &page, &obj_idx);
Minchan Kim37836892016-07-26 15:23:23 -07001382 zspage = get_zspage(page);
1383 get_zspage_mapping(zspage, &class_idx, &fg);
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001384 class = pool->size_class[class_idx];
Minchan Kimbfd093f2016-07-26 15:23:28 -07001385 off = (class->size * obj_idx) & ~PAGE_MASK;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001386
1387 area = this_cpu_ptr(&zs_map_area);
1388 if (off + class->size <= PAGE_SIZE)
1389 kunmap_atomic(area->vm_addr);
1390 else {
1391 struct page *pages[2];
1392
1393 pages[0] = page;
1394 pages[1] = get_next_page(page);
1395 BUG_ON(!pages[1]);
1396
1397 __zs_unmap_object(area, pages, off, class->size);
1398 }
1399 put_cpu_var(zs_map_area);
Minchan Kim48b48002016-07-26 15:23:31 -07001400
1401 migrate_read_unlock(zspage);
Minchan Kim312fcae2015-04-15 16:15:30 -07001402 unpin_tag(handle);
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001403}
1404EXPORT_SYMBOL_GPL(zs_unmap_object);
1405
Sergey Senozhatsky010b4952018-04-05 16:24:43 -07001406/**
1407 * zs_huge_class_size() - Returns the size (in bytes) of the first huge
1408 * zsmalloc &size_class.
1409 * @pool: zsmalloc pool to use
1410 *
1411 * The function returns the size of the first huge class - any object of equal
1412 * or bigger size will be stored in zspage consisting of a single physical
1413 * page.
1414 *
1415 * Context: Any context.
1416 *
1417 * Return: the size (in bytes) of the first huge zsmalloc &size_class.
1418 */
1419size_t zs_huge_class_size(struct zs_pool *pool)
1420{
1421 return huge_class_size;
1422}
1423EXPORT_SYMBOL_GPL(zs_huge_class_size);
1424
Minchan Kim251cbb92016-05-20 16:59:42 -07001425static unsigned long obj_malloc(struct size_class *class,
Minchan Kim37836892016-07-26 15:23:23 -07001426 struct zspage *zspage, unsigned long handle)
Minchan Kimc7806262015-04-15 16:15:26 -07001427{
Minchan Kimbfd093f2016-07-26 15:23:28 -07001428 int i, nr_page, offset;
Minchan Kimc7806262015-04-15 16:15:26 -07001429 unsigned long obj;
1430 struct link_free *link;
1431
1432 struct page *m_page;
Minchan Kimbfd093f2016-07-26 15:23:28 -07001433 unsigned long m_offset;
Minchan Kimc7806262015-04-15 16:15:26 -07001434 void *vaddr;
1435
Minchan Kim312fcae2015-04-15 16:15:30 -07001436 handle |= OBJ_ALLOCATED_TAG;
Minchan Kim37836892016-07-26 15:23:23 -07001437 obj = get_freeobj(zspage);
Minchan Kimbfd093f2016-07-26 15:23:28 -07001438
1439 offset = obj * class->size;
1440 nr_page = offset >> PAGE_SHIFT;
1441 m_offset = offset & ~PAGE_MASK;
1442 m_page = get_first_page(zspage);
1443
1444 for (i = 0; i < nr_page; i++)
1445 m_page = get_next_page(m_page);
Minchan Kimc7806262015-04-15 16:15:26 -07001446
1447 vaddr = kmap_atomic(m_page);
1448 link = (struct link_free *)vaddr + m_offset / sizeof(*link);
Minchan Kim3b1d9ca2016-07-26 15:23:37 -07001449 set_freeobj(zspage, link->next >> OBJ_TAG_BITS);
Minchan Kim48b48002016-07-26 15:23:31 -07001450 if (likely(!PageHugeObject(m_page)))
Minchan Kim7b60a682015-04-15 16:15:39 -07001451 /* record handle in the header of allocated chunk */
1452 link->handle = handle;
1453 else
Minchan Kim37836892016-07-26 15:23:23 -07001454 /* record handle to page->index */
1455 zspage->first_page->index = handle;
1456
Minchan Kimc7806262015-04-15 16:15:26 -07001457 kunmap_atomic(vaddr);
Minchan Kim37836892016-07-26 15:23:23 -07001458 mod_zspage_inuse(zspage, 1);
Minchan Kimc7806262015-04-15 16:15:26 -07001459 zs_stat_inc(class, OBJ_USED, 1);
1460
Minchan Kimbfd093f2016-07-26 15:23:28 -07001461 obj = location_to_obj(m_page, obj);
1462
Minchan Kimc7806262015-04-15 16:15:26 -07001463 return obj;
1464}
1465
1466
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001467/**
1468 * zs_malloc - Allocate block of given size from pool.
1469 * @pool: pool to allocate from
1470 * @size: size of block to allocate
Ganesh Mahendranfd854462016-07-28 15:47:54 -07001471 * @gfp: gfp flags when allocating object
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001472 *
1473 * On success, handle to the allocated object is returned,
1474 * otherwise 0.
1475 * Allocation requests with size > ZS_MAX_ALLOC_SIZE will fail.
1476 */
Sergey Senozhatskyd0d8da22016-05-20 16:59:48 -07001477unsigned long zs_malloc(struct zs_pool *pool, size_t size, gfp_t gfp)
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001478{
Minchan Kim2e40e162015-04-15 16:15:23 -07001479 unsigned long handle, obj;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001480 struct size_class *class;
Minchan Kim48b48002016-07-26 15:23:31 -07001481 enum fullness_group newfg;
Minchan Kim37836892016-07-26 15:23:23 -07001482 struct zspage *zspage;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001483
Minchan Kim7b60a682015-04-15 16:15:39 -07001484 if (unlikely(!size || size > ZS_MAX_ALLOC_SIZE))
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001485 return 0;
1486
Minchan Kim37836892016-07-26 15:23:23 -07001487 handle = cache_alloc_handle(pool, gfp);
Minchan Kim2e40e162015-04-15 16:15:23 -07001488 if (!handle)
1489 return 0;
1490
1491 /* extra space in chunk to keep the handle */
1492 size += ZS_HANDLE_SIZE;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001493 class = pool->size_class[get_size_class_index(size)];
1494
1495 spin_lock(&class->lock);
Minchan Kim37836892016-07-26 15:23:23 -07001496 zspage = find_get_zspage(class);
Minchan Kim48b48002016-07-26 15:23:31 -07001497 if (likely(zspage)) {
1498 obj = obj_malloc(class, zspage, handle);
1499 /* Now move the zspage to another fullness group, if required */
1500 fix_fullness_group(class, zspage);
1501 record_obj(handle, obj);
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001502 spin_unlock(&class->lock);
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001503
Minchan Kim48b48002016-07-26 15:23:31 -07001504 return handle;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001505 }
1506
Minchan Kim48b48002016-07-26 15:23:31 -07001507 spin_unlock(&class->lock);
1508
1509 zspage = alloc_zspage(pool, class, gfp);
1510 if (!zspage) {
1511 cache_free_handle(pool, handle);
1512 return 0;
1513 }
1514
1515 spin_lock(&class->lock);
Minchan Kim37836892016-07-26 15:23:23 -07001516 obj = obj_malloc(class, zspage, handle);
Minchan Kim48b48002016-07-26 15:23:31 -07001517 newfg = get_fullness_group(class, zspage);
1518 insert_zspage(class, zspage, newfg);
1519 set_zspage_mapping(zspage, class->index, newfg);
Minchan Kim2e40e162015-04-15 16:15:23 -07001520 record_obj(handle, obj);
Minchan Kim48b48002016-07-26 15:23:31 -07001521 atomic_long_add(class->pages_per_zspage,
1522 &pool->pages_allocated);
Ganesh Mahendranb4fd07a2016-07-28 15:47:49 -07001523 zs_stat_inc(class, OBJ_ALLOCATED, class->objs_per_zspage);
Minchan Kim48b48002016-07-26 15:23:31 -07001524
1525 /* We completely set up zspage so mark them as movable */
1526 SetZsPageMovable(pool, zspage);
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001527 spin_unlock(&class->lock);
1528
Minchan Kim2e40e162015-04-15 16:15:23 -07001529 return handle;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001530}
1531EXPORT_SYMBOL_GPL(zs_malloc);
1532
Minchan Kim1ee47162016-05-20 16:59:45 -07001533static void obj_free(struct size_class *class, unsigned long obj)
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001534{
1535 struct link_free *link;
Minchan Kim37836892016-07-26 15:23:23 -07001536 struct zspage *zspage;
1537 struct page *f_page;
Minchan Kimbfd093f2016-07-26 15:23:28 -07001538 unsigned long f_offset;
1539 unsigned int f_objidx;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001540 void *vaddr;
1541
Minchan Kim312fcae2015-04-15 16:15:30 -07001542 obj &= ~OBJ_ALLOCATED_TAG;
Minchan Kimc7806262015-04-15 16:15:26 -07001543 obj_to_location(obj, &f_page, &f_objidx);
Minchan Kimbfd093f2016-07-26 15:23:28 -07001544 f_offset = (class->size * f_objidx) & ~PAGE_MASK;
Minchan Kim37836892016-07-26 15:23:23 -07001545 zspage = get_zspage(f_page);
Minchan Kimc7806262015-04-15 16:15:26 -07001546
Minchan Kimc7806262015-04-15 16:15:26 -07001547 vaddr = kmap_atomic(f_page);
1548
1549 /* Insert this object in containing zspage's freelist */
1550 link = (struct link_free *)(vaddr + f_offset);
Minchan Kim3b1d9ca2016-07-26 15:23:37 -07001551 link->next = get_freeobj(zspage) << OBJ_TAG_BITS;
Minchan Kimc7806262015-04-15 16:15:26 -07001552 kunmap_atomic(vaddr);
Minchan Kimbfd093f2016-07-26 15:23:28 -07001553 set_freeobj(zspage, f_objidx);
Minchan Kim37836892016-07-26 15:23:23 -07001554 mod_zspage_inuse(zspage, -1);
Minchan Kimc7806262015-04-15 16:15:26 -07001555 zs_stat_dec(class, OBJ_USED, 1);
1556}
1557
1558void zs_free(struct zs_pool *pool, unsigned long handle)
1559{
Minchan Kim37836892016-07-26 15:23:23 -07001560 struct zspage *zspage;
1561 struct page *f_page;
Minchan Kimbfd093f2016-07-26 15:23:28 -07001562 unsigned long obj;
1563 unsigned int f_objidx;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001564 int class_idx;
1565 struct size_class *class;
1566 enum fullness_group fullness;
Minchan Kim48b48002016-07-26 15:23:31 -07001567 bool isolated;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001568
Minchan Kim2e40e162015-04-15 16:15:23 -07001569 if (unlikely(!handle))
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001570 return;
1571
Minchan Kim312fcae2015-04-15 16:15:30 -07001572 pin_tag(handle);
Minchan Kim2e40e162015-04-15 16:15:23 -07001573 obj = handle_to_obj(handle);
Minchan Kim2e40e162015-04-15 16:15:23 -07001574 obj_to_location(obj, &f_page, &f_objidx);
Minchan Kim37836892016-07-26 15:23:23 -07001575 zspage = get_zspage(f_page);
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001576
Minchan Kim48b48002016-07-26 15:23:31 -07001577 migrate_read_lock(zspage);
1578
Minchan Kim37836892016-07-26 15:23:23 -07001579 get_zspage_mapping(zspage, &class_idx, &fullness);
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001580 class = pool->size_class[class_idx];
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001581
1582 spin_lock(&class->lock);
Minchan Kim1ee47162016-05-20 16:59:45 -07001583 obj_free(class, obj);
Minchan Kim37836892016-07-26 15:23:23 -07001584 fullness = fix_fullness_group(class, zspage);
Minchan Kim48b48002016-07-26 15:23:31 -07001585 if (fullness != ZS_EMPTY) {
1586 migrate_read_unlock(zspage);
1587 goto out;
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001588 }
Minchan Kim48b48002016-07-26 15:23:31 -07001589
1590 isolated = is_zspage_isolated(zspage);
1591 migrate_read_unlock(zspage);
1592 /* If zspage is isolated, zs_page_putback will free the zspage */
1593 if (likely(!isolated))
1594 free_zspage(pool, class, zspage);
1595out:
1596
Minchan Kim312fcae2015-04-15 16:15:30 -07001597 spin_unlock(&class->lock);
1598 unpin_tag(handle);
Minchan Kim37836892016-07-26 15:23:23 -07001599 cache_free_handle(pool, handle);
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08001600}
1601EXPORT_SYMBOL_GPL(zs_free);
1602
Minchan Kim251cbb92016-05-20 16:59:42 -07001603static void zs_object_copy(struct size_class *class, unsigned long dst,
1604 unsigned long src)
Minchan Kim312fcae2015-04-15 16:15:30 -07001605{
1606 struct page *s_page, *d_page;
Minchan Kimbfd093f2016-07-26 15:23:28 -07001607 unsigned int s_objidx, d_objidx;
Minchan Kim312fcae2015-04-15 16:15:30 -07001608 unsigned long s_off, d_off;
1609 void *s_addr, *d_addr;
1610 int s_size, d_size, size;
1611 int written = 0;
1612
1613 s_size = d_size = class->size;
1614
1615 obj_to_location(src, &s_page, &s_objidx);
1616 obj_to_location(dst, &d_page, &d_objidx);
1617
Minchan Kimbfd093f2016-07-26 15:23:28 -07001618 s_off = (class->size * s_objidx) & ~PAGE_MASK;
1619 d_off = (class->size * d_objidx) & ~PAGE_MASK;
Minchan Kim312fcae2015-04-15 16:15:30 -07001620
1621 if (s_off + class->size > PAGE_SIZE)
1622 s_size = PAGE_SIZE - s_off;
1623
1624 if (d_off + class->size > PAGE_SIZE)
1625 d_size = PAGE_SIZE - d_off;
1626
1627 s_addr = kmap_atomic(s_page);
1628 d_addr = kmap_atomic(d_page);
1629
1630 while (1) {
1631 size = min(s_size, d_size);
1632 memcpy(d_addr + d_off, s_addr + s_off, size);
1633 written += size;
1634
1635 if (written == class->size)
1636 break;
1637
Sergey Senozhatsky495819e2015-04-15 16:16:15 -07001638 s_off += size;
1639 s_size -= size;
1640 d_off += size;
1641 d_size -= size;
1642
1643 if (s_off >= PAGE_SIZE) {
Minchan Kim312fcae2015-04-15 16:15:30 -07001644 kunmap_atomic(d_addr);
1645 kunmap_atomic(s_addr);
1646 s_page = get_next_page(s_page);
Minchan Kim312fcae2015-04-15 16:15:30 -07001647 s_addr = kmap_atomic(s_page);
1648 d_addr = kmap_atomic(d_page);
1649 s_size = class->size - written;
1650 s_off = 0;
Minchan Kim312fcae2015-04-15 16:15:30 -07001651 }
1652
Sergey Senozhatsky495819e2015-04-15 16:16:15 -07001653 if (d_off >= PAGE_SIZE) {
Minchan Kim312fcae2015-04-15 16:15:30 -07001654 kunmap_atomic(d_addr);
1655 d_page = get_next_page(d_page);
Minchan Kim312fcae2015-04-15 16:15:30 -07001656 d_addr = kmap_atomic(d_page);
1657 d_size = class->size - written;
1658 d_off = 0;
Minchan Kim312fcae2015-04-15 16:15:30 -07001659 }
1660 }
1661
1662 kunmap_atomic(d_addr);
1663 kunmap_atomic(s_addr);
1664}
1665
1666/*
1667 * Find alloced object in zspage from index object and
1668 * return handle.
1669 */
Minchan Kim251cbb92016-05-20 16:59:42 -07001670static unsigned long find_alloced_obj(struct size_class *class,
Ganesh Mahendrancf675ac2016-07-28 15:47:46 -07001671 struct page *page, int *obj_idx)
Minchan Kim312fcae2015-04-15 16:15:30 -07001672{
1673 unsigned long head;
1674 int offset = 0;
Ganesh Mahendrancf675ac2016-07-28 15:47:46 -07001675 int index = *obj_idx;
Minchan Kim312fcae2015-04-15 16:15:30 -07001676 unsigned long handle = 0;
1677 void *addr = kmap_atomic(page);
1678
Minchan Kim37836892016-07-26 15:23:23 -07001679 offset = get_first_obj_offset(page);
Minchan Kim312fcae2015-04-15 16:15:30 -07001680 offset += class->size * index;
1681
1682 while (offset < PAGE_SIZE) {
Minchan Kim48b48002016-07-26 15:23:31 -07001683 head = obj_to_head(page, addr + offset);
Minchan Kim312fcae2015-04-15 16:15:30 -07001684 if (head & OBJ_ALLOCATED_TAG) {
1685 handle = head & ~OBJ_ALLOCATED_TAG;
1686 if (trypin_tag(handle))
1687 break;
1688 handle = 0;
1689 }
1690
1691 offset += class->size;
1692 index++;
1693 }
1694
1695 kunmap_atomic(addr);
Ganesh Mahendrancf675ac2016-07-28 15:47:46 -07001696
1697 *obj_idx = index;
1698
Minchan Kim312fcae2015-04-15 16:15:30 -07001699 return handle;
1700}
1701
1702struct zs_compact_control {
Minchan Kim37836892016-07-26 15:23:23 -07001703 /* Source spage for migration which could be a subpage of zspage */
Minchan Kim312fcae2015-04-15 16:15:30 -07001704 struct page *s_page;
1705 /* Destination page for migration which should be a first page
1706 * of zspage. */
1707 struct page *d_page;
1708 /* Starting object index within @s_page which used for live object
1709 * in the subpage. */
Ganesh Mahendran41b88e12016-07-28 15:47:43 -07001710 int obj_idx;
Minchan Kim312fcae2015-04-15 16:15:30 -07001711};
1712
1713static int migrate_zspage(struct zs_pool *pool, struct size_class *class,
1714 struct zs_compact_control *cc)
1715{
1716 unsigned long used_obj, free_obj;
1717 unsigned long handle;
1718 struct page *s_page = cc->s_page;
1719 struct page *d_page = cc->d_page;
Ganesh Mahendran41b88e12016-07-28 15:47:43 -07001720 int obj_idx = cc->obj_idx;
Minchan Kim312fcae2015-04-15 16:15:30 -07001721 int ret = 0;
1722
1723 while (1) {
Ganesh Mahendrancf675ac2016-07-28 15:47:46 -07001724 handle = find_alloced_obj(class, s_page, &obj_idx);
Minchan Kim312fcae2015-04-15 16:15:30 -07001725 if (!handle) {
1726 s_page = get_next_page(s_page);
1727 if (!s_page)
1728 break;
Ganesh Mahendran41b88e12016-07-28 15:47:43 -07001729 obj_idx = 0;
Minchan Kim312fcae2015-04-15 16:15:30 -07001730 continue;
1731 }
1732
1733 /* Stop if there is no more space */
Minchan Kim37836892016-07-26 15:23:23 -07001734 if (zspage_full(class, get_zspage(d_page))) {
Minchan Kim312fcae2015-04-15 16:15:30 -07001735 unpin_tag(handle);
1736 ret = -ENOMEM;
1737 break;
1738 }
1739
1740 used_obj = handle_to_obj(handle);
Minchan Kim37836892016-07-26 15:23:23 -07001741 free_obj = obj_malloc(class, get_zspage(d_page), handle);
Minchan Kim251cbb92016-05-20 16:59:42 -07001742 zs_object_copy(class, free_obj, used_obj);
Ganesh Mahendran41b88e12016-07-28 15:47:43 -07001743 obj_idx++;
Junil Leec102f072016-01-20 14:58:18 -08001744 /*
1745 * record_obj updates handle's value to free_obj and it will
1746 * invalidate lock bit(ie, HANDLE_PIN_BIT) of handle, which
1747 * breaks synchronization using pin_tag(e,g, zs_free) so
1748 * let's keep the lock bit.
1749 */
1750 free_obj |= BIT(HANDLE_PIN_BIT);
Minchan Kim312fcae2015-04-15 16:15:30 -07001751 record_obj(handle, free_obj);
1752 unpin_tag(handle);
Minchan Kim1ee47162016-05-20 16:59:45 -07001753 obj_free(class, used_obj);
Minchan Kim312fcae2015-04-15 16:15:30 -07001754 }
1755
1756 /* Remember last position in this iteration */
1757 cc->s_page = s_page;
Ganesh Mahendran41b88e12016-07-28 15:47:43 -07001758 cc->obj_idx = obj_idx;
Minchan Kim312fcae2015-04-15 16:15:30 -07001759
1760 return ret;
1761}
1762
Minchan Kim37836892016-07-26 15:23:23 -07001763static struct zspage *isolate_zspage(struct size_class *class, bool source)
Minchan Kim312fcae2015-04-15 16:15:30 -07001764{
1765 int i;
Minchan Kim37836892016-07-26 15:23:23 -07001766 struct zspage *zspage;
1767 enum fullness_group fg[2] = {ZS_ALMOST_EMPTY, ZS_ALMOST_FULL};
Minchan Kim312fcae2015-04-15 16:15:30 -07001768
Minchan Kim37836892016-07-26 15:23:23 -07001769 if (!source) {
1770 fg[0] = ZS_ALMOST_FULL;
1771 fg[1] = ZS_ALMOST_EMPTY;
1772 }
1773
1774 for (i = 0; i < 2; i++) {
1775 zspage = list_first_entry_or_null(&class->fullness_list[fg[i]],
1776 struct zspage, list);
1777 if (zspage) {
Minchan Kim48b48002016-07-26 15:23:31 -07001778 VM_BUG_ON(is_zspage_isolated(zspage));
Minchan Kim37836892016-07-26 15:23:23 -07001779 remove_zspage(class, zspage, fg[i]);
1780 return zspage;
Minchan Kim312fcae2015-04-15 16:15:30 -07001781 }
1782 }
1783
Minchan Kim37836892016-07-26 15:23:23 -07001784 return zspage;
Minchan Kim312fcae2015-04-15 16:15:30 -07001785}
1786
Sergey Senozhatsky860c7072015-09-08 15:04:38 -07001787/*
Minchan Kim37836892016-07-26 15:23:23 -07001788 * putback_zspage - add @zspage into right class's fullness list
Sergey Senozhatsky860c7072015-09-08 15:04:38 -07001789 * @class: destination class
Minchan Kim37836892016-07-26 15:23:23 -07001790 * @zspage: target page
Sergey Senozhatsky860c7072015-09-08 15:04:38 -07001791 *
Minchan Kim37836892016-07-26 15:23:23 -07001792 * Return @zspage's fullness_group
Sergey Senozhatsky860c7072015-09-08 15:04:38 -07001793 */
Minchan Kim4aa409c2016-07-26 15:23:26 -07001794static enum fullness_group putback_zspage(struct size_class *class,
Minchan Kim37836892016-07-26 15:23:23 -07001795 struct zspage *zspage)
Minchan Kim312fcae2015-04-15 16:15:30 -07001796{
Minchan Kim312fcae2015-04-15 16:15:30 -07001797 enum fullness_group fullness;
1798
Minchan Kim48b48002016-07-26 15:23:31 -07001799 VM_BUG_ON(is_zspage_isolated(zspage));
1800
Minchan Kim37836892016-07-26 15:23:23 -07001801 fullness = get_fullness_group(class, zspage);
1802 insert_zspage(class, zspage, fullness);
1803 set_zspage_mapping(zspage, class->index, fullness);
Minchan Kim839373e2015-04-15 16:16:18 -07001804
Sergey Senozhatsky860c7072015-09-08 15:04:38 -07001805 return fullness;
Minchan Kim312fcae2015-04-15 16:15:30 -07001806}
1807
Minchan Kim48b48002016-07-26 15:23:31 -07001808#ifdef CONFIG_COMPACTION
Colin Ian King4d0a5402018-08-17 15:46:50 -07001809/*
1810 * To prevent zspage destroy during migration, zspage freeing should
1811 * hold locks of all pages in the zspage.
1812 */
1813static void lock_zspage(struct zspage *zspage)
1814{
1815 struct page *page = get_first_page(zspage);
1816
1817 do {
1818 lock_page(page);
1819 } while ((page = get_next_page(page)) != NULL);
1820}
1821
Minchan Kim48b48002016-07-26 15:23:31 -07001822static struct dentry *zs_mount(struct file_system_type *fs_type,
1823 int flags, const char *dev_name, void *data)
1824{
1825 static const struct dentry_operations ops = {
1826 .d_dname = simple_dname,
1827 };
1828
1829 return mount_pseudo(fs_type, "zsmalloc:", NULL, &ops, ZSMALLOC_MAGIC);
1830}
1831
1832static struct file_system_type zsmalloc_fs = {
1833 .name = "zsmalloc",
1834 .mount = zs_mount,
1835 .kill_sb = kill_anon_super,
1836};
1837
1838static int zsmalloc_mount(void)
1839{
1840 int ret = 0;
1841
1842 zsmalloc_mnt = kern_mount(&zsmalloc_fs);
1843 if (IS_ERR(zsmalloc_mnt))
1844 ret = PTR_ERR(zsmalloc_mnt);
1845
1846 return ret;
1847}
1848
1849static void zsmalloc_unmount(void)
1850{
1851 kern_unmount(zsmalloc_mnt);
1852}
1853
1854static void migrate_lock_init(struct zspage *zspage)
1855{
1856 rwlock_init(&zspage->lock);
1857}
1858
1859static void migrate_read_lock(struct zspage *zspage)
1860{
1861 read_lock(&zspage->lock);
1862}
1863
1864static void migrate_read_unlock(struct zspage *zspage)
1865{
1866 read_unlock(&zspage->lock);
1867}
1868
1869static void migrate_write_lock(struct zspage *zspage)
1870{
1871 write_lock(&zspage->lock);
1872}
1873
1874static void migrate_write_unlock(struct zspage *zspage)
1875{
1876 write_unlock(&zspage->lock);
1877}
1878
1879/* Number of isolated subpage for *page migration* in this zspage */
1880static void inc_zspage_isolation(struct zspage *zspage)
1881{
1882 zspage->isolated++;
1883}
1884
1885static void dec_zspage_isolation(struct zspage *zspage)
1886{
1887 zspage->isolated--;
1888}
1889
Henry Burnsb30a2f62019-08-24 17:55:03 -07001890static void putback_zspage_deferred(struct zs_pool *pool,
1891 struct size_class *class,
1892 struct zspage *zspage)
1893{
1894 enum fullness_group fg;
1895
1896 fg = putback_zspage(class, zspage);
1897 if (fg == ZS_EMPTY)
1898 schedule_work(&pool->free_work);
1899
1900}
1901
Henry Burnsed11e602019-08-24 17:55:06 -07001902static inline void zs_pool_dec_isolated(struct zs_pool *pool)
1903{
1904 VM_BUG_ON(atomic_long_read(&pool->isolated_pages) <= 0);
1905 atomic_long_dec(&pool->isolated_pages);
1906 /*
1907 * There's no possibility of racing, since wait_for_isolated_drain()
1908 * checks the isolated count under &class->lock after enqueuing
1909 * on migration_wait.
1910 */
1911 if (atomic_long_read(&pool->isolated_pages) == 0 && pool->destroying)
1912 wake_up_all(&pool->migration_wait);
1913}
1914
Minchan Kim48b48002016-07-26 15:23:31 -07001915static void replace_sub_page(struct size_class *class, struct zspage *zspage,
1916 struct page *newpage, struct page *oldpage)
1917{
1918 struct page *page;
1919 struct page *pages[ZS_MAX_PAGES_PER_ZSPAGE] = {NULL, };
1920 int idx = 0;
1921
1922 page = get_first_page(zspage);
1923 do {
1924 if (page == oldpage)
1925 pages[idx] = newpage;
1926 else
1927 pages[idx] = page;
1928 idx++;
1929 } while ((page = get_next_page(page)) != NULL);
1930
1931 create_page_chain(class, zspage, pages);
1932 set_first_obj_offset(newpage, get_first_obj_offset(oldpage));
1933 if (unlikely(PageHugeObject(oldpage)))
1934 newpage->index = oldpage->index;
1935 __SetPageMovable(newpage, page_mapping(oldpage));
1936}
1937
Colin Ian King4d0a5402018-08-17 15:46:50 -07001938static bool zs_page_isolate(struct page *page, isolate_mode_t mode)
Minchan Kim48b48002016-07-26 15:23:31 -07001939{
1940 struct zs_pool *pool;
1941 struct size_class *class;
1942 int class_idx;
1943 enum fullness_group fullness;
1944 struct zspage *zspage;
1945 struct address_space *mapping;
1946
1947 /*
1948 * Page is locked so zspage couldn't be destroyed. For detail, look at
1949 * lock_zspage in free_zspage.
1950 */
1951 VM_BUG_ON_PAGE(!PageMovable(page), page);
1952 VM_BUG_ON_PAGE(PageIsolated(page), page);
1953
1954 zspage = get_zspage(page);
1955
1956 /*
1957 * Without class lock, fullness could be stale while class_idx is okay
1958 * because class_idx is constant unless page is freed so we should get
1959 * fullness again under class lock.
1960 */
1961 get_zspage_mapping(zspage, &class_idx, &fullness);
1962 mapping = page_mapping(page);
1963 pool = mapping->private_data;
1964 class = pool->size_class[class_idx];
1965
1966 spin_lock(&class->lock);
1967 if (get_zspage_inuse(zspage) == 0) {
1968 spin_unlock(&class->lock);
1969 return false;
1970 }
1971
1972 /* zspage is isolated for object migration */
1973 if (list_empty(&zspage->list) && !is_zspage_isolated(zspage)) {
1974 spin_unlock(&class->lock);
1975 return false;
1976 }
1977
1978 /*
1979 * If this is first time isolation for the zspage, isolate zspage from
1980 * size_class to prevent further object allocation from the zspage.
1981 */
1982 if (!list_empty(&zspage->list) && !is_zspage_isolated(zspage)) {
1983 get_zspage_mapping(zspage, &class_idx, &fullness);
Henry Burnsed11e602019-08-24 17:55:06 -07001984 atomic_long_inc(&pool->isolated_pages);
Minchan Kim48b48002016-07-26 15:23:31 -07001985 remove_zspage(class, zspage, fullness);
1986 }
1987
1988 inc_zspage_isolation(zspage);
1989 spin_unlock(&class->lock);
1990
1991 return true;
1992}
1993
Colin Ian King4d0a5402018-08-17 15:46:50 -07001994static int zs_page_migrate(struct address_space *mapping, struct page *newpage,
Minchan Kim48b48002016-07-26 15:23:31 -07001995 struct page *page, enum migrate_mode mode)
1996{
1997 struct zs_pool *pool;
1998 struct size_class *class;
1999 int class_idx;
2000 enum fullness_group fullness;
2001 struct zspage *zspage;
2002 struct page *dummy;
2003 void *s_addr, *d_addr, *addr;
2004 int offset, pos;
2005 unsigned long handle, head;
2006 unsigned long old_obj, new_obj;
2007 unsigned int obj_idx;
2008 int ret = -EAGAIN;
2009
Jérôme Glisse2916ecc2017-09-08 16:12:06 -07002010 /*
2011 * We cannot support the _NO_COPY case here, because copy needs to
2012 * happen under the zs lock, which does not work with
2013 * MIGRATE_SYNC_NO_COPY workflow.
2014 */
2015 if (mode == MIGRATE_SYNC_NO_COPY)
2016 return -EINVAL;
2017
Minchan Kim48b48002016-07-26 15:23:31 -07002018 VM_BUG_ON_PAGE(!PageMovable(page), page);
2019 VM_BUG_ON_PAGE(!PageIsolated(page), page);
2020
2021 zspage = get_zspage(page);
2022
2023 /* Concurrent compactor cannot migrate any subpage in zspage */
2024 migrate_write_lock(zspage);
2025 get_zspage_mapping(zspage, &class_idx, &fullness);
2026 pool = mapping->private_data;
2027 class = pool->size_class[class_idx];
2028 offset = get_first_obj_offset(page);
2029
2030 spin_lock(&class->lock);
2031 if (!get_zspage_inuse(zspage)) {
Hui Zhu77ff4652017-09-06 16:21:08 -07002032 /*
2033 * Set "offset" to end of the page so that every loops
2034 * skips unnecessary object scanning.
2035 */
2036 offset = PAGE_SIZE;
Minchan Kim48b48002016-07-26 15:23:31 -07002037 }
2038
2039 pos = offset;
2040 s_addr = kmap_atomic(page);
2041 while (pos < PAGE_SIZE) {
2042 head = obj_to_head(page, s_addr + pos);
2043 if (head & OBJ_ALLOCATED_TAG) {
2044 handle = head & ~OBJ_ALLOCATED_TAG;
2045 if (!trypin_tag(handle))
2046 goto unpin_objects;
2047 }
2048 pos += class->size;
2049 }
2050
2051 /*
2052 * Here, any user cannot access all objects in the zspage so let's move.
2053 */
2054 d_addr = kmap_atomic(newpage);
2055 memcpy(d_addr, s_addr, PAGE_SIZE);
2056 kunmap_atomic(d_addr);
2057
2058 for (addr = s_addr + offset; addr < s_addr + pos;
2059 addr += class->size) {
2060 head = obj_to_head(page, addr);
2061 if (head & OBJ_ALLOCATED_TAG) {
2062 handle = head & ~OBJ_ALLOCATED_TAG;
2063 if (!testpin_tag(handle))
2064 BUG();
2065
2066 old_obj = handle_to_obj(handle);
2067 obj_to_location(old_obj, &dummy, &obj_idx);
2068 new_obj = (unsigned long)location_to_obj(newpage,
2069 obj_idx);
2070 new_obj |= BIT(HANDLE_PIN_BIT);
2071 record_obj(handle, new_obj);
2072 }
2073 }
2074
2075 replace_sub_page(class, zspage, newpage, page);
2076 get_page(newpage);
2077
2078 dec_zspage_isolation(zspage);
2079
2080 /*
2081 * Page migration is done so let's putback isolated zspage to
2082 * the list if @page is final isolated subpage in the zspage.
2083 */
Henry Burnsed11e602019-08-24 17:55:06 -07002084 if (!is_zspage_isolated(zspage)) {
2085 /*
2086 * We cannot race with zs_destroy_pool() here because we wait
2087 * for isolation to hit zero before we start destroying.
2088 * Also, we ensure that everyone can see pool->destroying before
2089 * we start waiting.
2090 */
Henry Burnsb30a2f62019-08-24 17:55:03 -07002091 putback_zspage_deferred(pool, class, zspage);
Henry Burnsed11e602019-08-24 17:55:06 -07002092 zs_pool_dec_isolated(pool);
2093 }
Minchan Kim48b48002016-07-26 15:23:31 -07002094
Chanho Minb9fffe52020-01-04 12:59:36 -08002095 if (page_zone(newpage) != page_zone(page)) {
2096 dec_zone_page_state(page, NR_ZSPAGES);
2097 inc_zone_page_state(newpage, NR_ZSPAGES);
2098 }
2099
Minchan Kim48b48002016-07-26 15:23:31 -07002100 reset_page(page);
2101 put_page(page);
2102 page = newpage;
2103
Minchan Kimdd4123f2016-07-26 15:26:50 -07002104 ret = MIGRATEPAGE_SUCCESS;
Minchan Kim48b48002016-07-26 15:23:31 -07002105unpin_objects:
2106 for (addr = s_addr + offset; addr < s_addr + pos;
2107 addr += class->size) {
2108 head = obj_to_head(page, addr);
2109 if (head & OBJ_ALLOCATED_TAG) {
2110 handle = head & ~OBJ_ALLOCATED_TAG;
2111 if (!testpin_tag(handle))
2112 BUG();
2113 unpin_tag(handle);
2114 }
2115 }
2116 kunmap_atomic(s_addr);
Minchan Kim48b48002016-07-26 15:23:31 -07002117 spin_unlock(&class->lock);
2118 migrate_write_unlock(zspage);
2119
2120 return ret;
2121}
2122
Colin Ian King4d0a5402018-08-17 15:46:50 -07002123static void zs_page_putback(struct page *page)
Minchan Kim48b48002016-07-26 15:23:31 -07002124{
2125 struct zs_pool *pool;
2126 struct size_class *class;
2127 int class_idx;
2128 enum fullness_group fg;
2129 struct address_space *mapping;
2130 struct zspage *zspage;
2131
2132 VM_BUG_ON_PAGE(!PageMovable(page), page);
2133 VM_BUG_ON_PAGE(!PageIsolated(page), page);
2134
2135 zspage = get_zspage(page);
2136 get_zspage_mapping(zspage, &class_idx, &fg);
2137 mapping = page_mapping(page);
2138 pool = mapping->private_data;
2139 class = pool->size_class[class_idx];
2140
2141 spin_lock(&class->lock);
2142 dec_zspage_isolation(zspage);
2143 if (!is_zspage_isolated(zspage)) {
Minchan Kim48b48002016-07-26 15:23:31 -07002144 /*
2145 * Due to page_lock, we cannot free zspage immediately
2146 * so let's defer.
2147 */
Henry Burnsb30a2f62019-08-24 17:55:03 -07002148 putback_zspage_deferred(pool, class, zspage);
Henry Burnsed11e602019-08-24 17:55:06 -07002149 zs_pool_dec_isolated(pool);
Minchan Kim48b48002016-07-26 15:23:31 -07002150 }
2151 spin_unlock(&class->lock);
2152}
2153
Colin Ian King4d0a5402018-08-17 15:46:50 -07002154static const struct address_space_operations zsmalloc_aops = {
Minchan Kim48b48002016-07-26 15:23:31 -07002155 .isolate_page = zs_page_isolate,
2156 .migratepage = zs_page_migrate,
2157 .putback_page = zs_page_putback,
2158};
2159
2160static int zs_register_migration(struct zs_pool *pool)
2161{
2162 pool->inode = alloc_anon_inode(zsmalloc_mnt->mnt_sb);
2163 if (IS_ERR(pool->inode)) {
2164 pool->inode = NULL;
2165 return 1;
2166 }
2167
2168 pool->inode->i_mapping->private_data = pool;
2169 pool->inode->i_mapping->a_ops = &zsmalloc_aops;
2170 return 0;
2171}
2172
Henry Burnsed11e602019-08-24 17:55:06 -07002173static bool pool_isolated_are_drained(struct zs_pool *pool)
2174{
2175 return atomic_long_read(&pool->isolated_pages) == 0;
2176}
2177
2178/* Function for resolving migration */
2179static void wait_for_isolated_drain(struct zs_pool *pool)
2180{
2181
2182 /*
2183 * We're in the process of destroying the pool, so there are no
2184 * active allocations. zs_page_isolate() fails for completely free
2185 * zspages, so we need only wait for the zs_pool's isolated
2186 * count to hit zero.
2187 */
2188 wait_event(pool->migration_wait,
2189 pool_isolated_are_drained(pool));
2190}
2191
Minchan Kim48b48002016-07-26 15:23:31 -07002192static void zs_unregister_migration(struct zs_pool *pool)
2193{
Henry Burnsed11e602019-08-24 17:55:06 -07002194 pool->destroying = true;
2195 /*
2196 * We need a memory barrier here to ensure global visibility of
2197 * pool->destroying. Thus pool->isolated pages will either be 0 in which
2198 * case we don't care, or it will be > 0 and pool->destroying will
2199 * ensure that we wake up once isolation hits 0.
2200 */
2201 smp_mb();
2202 wait_for_isolated_drain(pool); /* This can block */
Minchan Kim48b48002016-07-26 15:23:31 -07002203 flush_work(&pool->free_work);
Markus Elfringc3491ec2016-07-28 15:48:59 -07002204 iput(pool->inode);
Minchan Kim48b48002016-07-26 15:23:31 -07002205}
2206
2207/*
2208 * Caller should hold page_lock of all pages in the zspage
2209 * In here, we cannot use zspage meta data.
2210 */
2211static void async_free_zspage(struct work_struct *work)
2212{
2213 int i;
2214 struct size_class *class;
2215 unsigned int class_idx;
2216 enum fullness_group fullness;
2217 struct zspage *zspage, *tmp;
2218 LIST_HEAD(free_pages);
2219 struct zs_pool *pool = container_of(work, struct zs_pool,
2220 free_work);
2221
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -07002222 for (i = 0; i < ZS_SIZE_CLASSES; i++) {
Minchan Kim48b48002016-07-26 15:23:31 -07002223 class = pool->size_class[i];
2224 if (class->index != i)
2225 continue;
2226
2227 spin_lock(&class->lock);
2228 list_splice_init(&class->fullness_list[ZS_EMPTY], &free_pages);
2229 spin_unlock(&class->lock);
2230 }
2231
2232
2233 list_for_each_entry_safe(zspage, tmp, &free_pages, list) {
2234 list_del(&zspage->list);
2235 lock_zspage(zspage);
2236
2237 get_zspage_mapping(zspage, &class_idx, &fullness);
2238 VM_BUG_ON(fullness != ZS_EMPTY);
2239 class = pool->size_class[class_idx];
2240 spin_lock(&class->lock);
2241 __free_zspage(pool, pool->size_class[class_idx], zspage);
2242 spin_unlock(&class->lock);
2243 }
2244};
2245
2246static void kick_deferred_free(struct zs_pool *pool)
2247{
2248 schedule_work(&pool->free_work);
2249}
2250
2251static void init_deferred_free(struct zs_pool *pool)
2252{
2253 INIT_WORK(&pool->free_work, async_free_zspage);
2254}
2255
2256static void SetZsPageMovable(struct zs_pool *pool, struct zspage *zspage)
2257{
2258 struct page *page = get_first_page(zspage);
2259
2260 do {
2261 WARN_ON(!trylock_page(page));
2262 __SetPageMovable(page, pool->inode->i_mapping);
2263 unlock_page(page);
2264 } while ((page = get_next_page(page)) != NULL);
2265}
2266#endif
2267
Sergey Senozhatsky04f05902015-09-08 15:04:30 -07002268/*
2269 *
2270 * Based on the number of unused allocated objects calculate
2271 * and return the number of pages that we can free.
Sergey Senozhatsky04f05902015-09-08 15:04:30 -07002272 */
2273static unsigned long zs_can_compact(struct size_class *class)
2274{
2275 unsigned long obj_wasted;
Sergey Senozhatsky44f43e92016-05-09 16:28:49 -07002276 unsigned long obj_allocated = zs_stat_get(class, OBJ_ALLOCATED);
2277 unsigned long obj_used = zs_stat_get(class, OBJ_USED);
Sergey Senozhatsky04f05902015-09-08 15:04:30 -07002278
Sergey Senozhatsky44f43e92016-05-09 16:28:49 -07002279 if (obj_allocated <= obj_used)
2280 return 0;
Sergey Senozhatsky04f05902015-09-08 15:04:30 -07002281
Sergey Senozhatsky44f43e92016-05-09 16:28:49 -07002282 obj_wasted = obj_allocated - obj_used;
Ganesh Mahendranb4fd07a2016-07-28 15:47:49 -07002283 obj_wasted /= class->objs_per_zspage;
Sergey Senozhatsky04f05902015-09-08 15:04:30 -07002284
Minchan Kim6cbf16b2015-09-08 15:04:49 -07002285 return obj_wasted * class->pages_per_zspage;
Sergey Senozhatsky04f05902015-09-08 15:04:30 -07002286}
2287
Sergey Senozhatsky7d3f3932015-09-08 15:04:35 -07002288static void __zs_compact(struct zs_pool *pool, struct size_class *class)
Minchan Kim312fcae2015-04-15 16:15:30 -07002289{
Minchan Kim312fcae2015-04-15 16:15:30 -07002290 struct zs_compact_control cc;
Minchan Kim37836892016-07-26 15:23:23 -07002291 struct zspage *src_zspage;
2292 struct zspage *dst_zspage = NULL;
Minchan Kim312fcae2015-04-15 16:15:30 -07002293
Minchan Kim312fcae2015-04-15 16:15:30 -07002294 spin_lock(&class->lock);
Minchan Kim37836892016-07-26 15:23:23 -07002295 while ((src_zspage = isolate_zspage(class, true))) {
Minchan Kim312fcae2015-04-15 16:15:30 -07002296
Sergey Senozhatsky04f05902015-09-08 15:04:30 -07002297 if (!zs_can_compact(class))
2298 break;
2299
Ganesh Mahendran41b88e12016-07-28 15:47:43 -07002300 cc.obj_idx = 0;
Minchan Kim48b48002016-07-26 15:23:31 -07002301 cc.s_page = get_first_page(src_zspage);
Minchan Kim312fcae2015-04-15 16:15:30 -07002302
Minchan Kim37836892016-07-26 15:23:23 -07002303 while ((dst_zspage = isolate_zspage(class, false))) {
Minchan Kim48b48002016-07-26 15:23:31 -07002304 cc.d_page = get_first_page(dst_zspage);
Minchan Kim312fcae2015-04-15 16:15:30 -07002305 /*
Sergey Senozhatsky0dc63d482015-09-08 15:04:33 -07002306 * If there is no more space in dst_page, resched
2307 * and see if anyone had allocated another zspage.
Minchan Kim312fcae2015-04-15 16:15:30 -07002308 */
2309 if (!migrate_zspage(pool, class, &cc))
2310 break;
2311
Minchan Kim4aa409c2016-07-26 15:23:26 -07002312 putback_zspage(class, dst_zspage);
Minchan Kim312fcae2015-04-15 16:15:30 -07002313 }
2314
2315 /* Stop if we couldn't find slot */
Minchan Kim37836892016-07-26 15:23:23 -07002316 if (dst_zspage == NULL)
Minchan Kim312fcae2015-04-15 16:15:30 -07002317 break;
2318
Minchan Kim4aa409c2016-07-26 15:23:26 -07002319 putback_zspage(class, dst_zspage);
2320 if (putback_zspage(class, src_zspage) == ZS_EMPTY) {
Minchan Kim48b48002016-07-26 15:23:31 -07002321 free_zspage(pool, class, src_zspage);
Minchan Kim6cbf16b2015-09-08 15:04:49 -07002322 pool->stats.pages_compacted += class->pages_per_zspage;
Minchan Kim4aa409c2016-07-26 15:23:26 -07002323 }
Minchan Kim312fcae2015-04-15 16:15:30 -07002324 spin_unlock(&class->lock);
Minchan Kim312fcae2015-04-15 16:15:30 -07002325 cond_resched();
2326 spin_lock(&class->lock);
2327 }
2328
Minchan Kim37836892016-07-26 15:23:23 -07002329 if (src_zspage)
Minchan Kim4aa409c2016-07-26 15:23:26 -07002330 putback_zspage(class, src_zspage);
Minchan Kim312fcae2015-04-15 16:15:30 -07002331
Sergey Senozhatsky7d3f3932015-09-08 15:04:35 -07002332 spin_unlock(&class->lock);
Minchan Kim312fcae2015-04-15 16:15:30 -07002333}
2334
2335unsigned long zs_compact(struct zs_pool *pool)
2336{
2337 int i;
Minchan Kim312fcae2015-04-15 16:15:30 -07002338 struct size_class *class;
2339
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -07002340 for (i = ZS_SIZE_CLASSES - 1; i >= 0; i--) {
Minchan Kim312fcae2015-04-15 16:15:30 -07002341 class = pool->size_class[i];
2342 if (!class)
2343 continue;
2344 if (class->index != i)
2345 continue;
Sergey Senozhatsky7d3f3932015-09-08 15:04:35 -07002346 __zs_compact(pool, class);
Minchan Kim312fcae2015-04-15 16:15:30 -07002347 }
2348
Sergey Senozhatsky860c7072015-09-08 15:04:38 -07002349 return pool->stats.pages_compacted;
Minchan Kim312fcae2015-04-15 16:15:30 -07002350}
2351EXPORT_SYMBOL_GPL(zs_compact);
2352
Sergey Senozhatsky7d3f3932015-09-08 15:04:35 -07002353void zs_pool_stats(struct zs_pool *pool, struct zs_pool_stats *stats)
2354{
2355 memcpy(stats, &pool->stats, sizeof(struct zs_pool_stats));
2356}
2357EXPORT_SYMBOL_GPL(zs_pool_stats);
2358
Sergey Senozhatskyab9d3062015-09-08 15:04:41 -07002359static unsigned long zs_shrinker_scan(struct shrinker *shrinker,
2360 struct shrink_control *sc)
2361{
2362 unsigned long pages_freed;
2363 struct zs_pool *pool = container_of(shrinker, struct zs_pool,
2364 shrinker);
2365
2366 pages_freed = pool->stats.pages_compacted;
2367 /*
2368 * Compact classes and calculate compaction delta.
2369 * Can run concurrently with a manually triggered
2370 * (by user) compaction.
2371 */
2372 pages_freed = zs_compact(pool) - pages_freed;
2373
2374 return pages_freed ? pages_freed : SHRINK_STOP;
2375}
2376
2377static unsigned long zs_shrinker_count(struct shrinker *shrinker,
2378 struct shrink_control *sc)
2379{
2380 int i;
2381 struct size_class *class;
2382 unsigned long pages_to_free = 0;
2383 struct zs_pool *pool = container_of(shrinker, struct zs_pool,
2384 shrinker);
2385
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -07002386 for (i = ZS_SIZE_CLASSES - 1; i >= 0; i--) {
Sergey Senozhatskyab9d3062015-09-08 15:04:41 -07002387 class = pool->size_class[i];
2388 if (!class)
2389 continue;
2390 if (class->index != i)
2391 continue;
2392
Sergey Senozhatskyab9d3062015-09-08 15:04:41 -07002393 pages_to_free += zs_can_compact(class);
Sergey Senozhatskyab9d3062015-09-08 15:04:41 -07002394 }
2395
2396 return pages_to_free;
2397}
2398
2399static void zs_unregister_shrinker(struct zs_pool *pool)
2400{
Aliaksei Karaliou93144ca2018-01-31 16:18:40 -08002401 unregister_shrinker(&pool->shrinker);
Sergey Senozhatskyab9d3062015-09-08 15:04:41 -07002402}
2403
2404static int zs_register_shrinker(struct zs_pool *pool)
2405{
2406 pool->shrinker.scan_objects = zs_shrinker_scan;
2407 pool->shrinker.count_objects = zs_shrinker_count;
2408 pool->shrinker.batch = 0;
2409 pool->shrinker.seeks = DEFAULT_SEEKS;
2410
2411 return register_shrinker(&pool->shrinker);
2412}
2413
Davidlohr Bueso4bbc0bc2013-01-04 12:14:00 -08002414/**
2415 * zs_create_pool - Creates an allocation pool to work from.
Ganesh Mahendranfd854462016-07-28 15:47:54 -07002416 * @name: pool name to be created
Davidlohr Bueso4bbc0bc2013-01-04 12:14:00 -08002417 *
2418 * This function must be called before anything when using
2419 * the zsmalloc allocator.
2420 *
2421 * On success, a pointer to the newly created pool is returned,
2422 * otherwise NULL.
2423 */
Sergey Senozhatskyd0d8da22016-05-20 16:59:48 -07002424struct zs_pool *zs_create_pool(const char *name)
Nitin Gupta61989a82012-01-09 16:51:56 -06002425{
Ganesh Mahendran18136652014-12-12 16:57:10 -08002426 int i;
Nitin Gupta61989a82012-01-09 16:51:56 -06002427 struct zs_pool *pool;
Ganesh Mahendrandf8b5bb2014-12-12 16:57:07 -08002428 struct size_class *prev_class = NULL;
Nitin Gupta61989a82012-01-09 16:51:56 -06002429
Ganesh Mahendran18136652014-12-12 16:57:10 -08002430 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
Nitin Gupta61989a82012-01-09 16:51:56 -06002431 if (!pool)
2432 return NULL;
2433
Minchan Kim48b48002016-07-26 15:23:31 -07002434 init_deferred_free(pool);
Ganesh Mahendran0f050d92015-02-12 15:00:54 -08002435
Minchan Kim2e40e162015-04-15 16:15:23 -07002436 pool->name = kstrdup(name, GFP_KERNEL);
2437 if (!pool->name)
2438 goto err;
2439
Andrew Morton5dd2db12019-08-30 16:04:35 -07002440#ifdef CONFIG_COMPACTION
Henry Burnsed11e602019-08-24 17:55:06 -07002441 init_waitqueue_head(&pool->migration_wait);
Andrew Morton5dd2db12019-08-30 16:04:35 -07002442#endif
Henry Burnsed11e602019-08-24 17:55:06 -07002443
Minchan Kim37836892016-07-26 15:23:23 -07002444 if (create_cache(pool))
Minchan Kim2e40e162015-04-15 16:15:23 -07002445 goto err;
Mahendran Ganesh40f9fb82014-12-12 16:57:01 -08002446
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002447 /*
Xishi Qiu399d8ee2017-02-22 15:45:01 -08002448 * Iterate reversely, because, size of size_class that we want to use
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002449 * for merging should be larger or equal to current size.
2450 */
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -07002451 for (i = ZS_SIZE_CLASSES - 1; i >= 0; i--) {
Nitin Gupta61989a82012-01-09 16:51:56 -06002452 int size;
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002453 int pages_per_zspage;
Ganesh Mahendran64d90462016-07-28 15:47:51 -07002454 int objs_per_zspage;
Nitin Gupta61989a82012-01-09 16:51:56 -06002455 struct size_class *class;
Minchan Kim37836892016-07-26 15:23:23 -07002456 int fullness = 0;
Nitin Gupta61989a82012-01-09 16:51:56 -06002457
2458 size = ZS_MIN_ALLOC_SIZE + i * ZS_SIZE_CLASS_DELTA;
2459 if (size > ZS_MAX_ALLOC_SIZE)
2460 size = ZS_MAX_ALLOC_SIZE;
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002461 pages_per_zspage = get_pages_per_zspage(size);
Ganesh Mahendran64d90462016-07-28 15:47:51 -07002462 objs_per_zspage = pages_per_zspage * PAGE_SIZE / size;
Nitin Gupta61989a82012-01-09 16:51:56 -06002463
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002464 /*
Sergey Senozhatsky010b4952018-04-05 16:24:43 -07002465 * We iterate from biggest down to smallest classes,
2466 * so huge_class_size holds the size of the first huge
2467 * class. Any object bigger than or equal to that will
2468 * endup in the huge class.
2469 */
2470 if (pages_per_zspage != 1 && objs_per_zspage != 1 &&
2471 !huge_class_size) {
2472 huge_class_size = size;
2473 /*
2474 * The object uses ZS_HANDLE_SIZE bytes to store the
2475 * handle. We need to subtract it, because zs_malloc()
2476 * unconditionally adds handle size before it performs
2477 * size class search - so object may be smaller than
2478 * huge class size, yet it still can end up in the huge
2479 * class because it grows by ZS_HANDLE_SIZE extra bytes
2480 * right before class lookup.
2481 */
2482 huge_class_size -= (ZS_HANDLE_SIZE - 1);
2483 }
2484
2485 /*
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002486 * size_class is used for normal zsmalloc operation such
2487 * as alloc/free for that size. Although it is natural that we
2488 * have one size_class for each size, there is a chance that we
2489 * can get more memory utilization if we use one size_class for
2490 * many different sizes whose size_class have same
2491 * characteristics. So, we makes size_class point to
2492 * previous size_class if possible.
2493 */
Ganesh Mahendrandf8b5bb2014-12-12 16:57:07 -08002494 if (prev_class) {
Ganesh Mahendran64d90462016-07-28 15:47:51 -07002495 if (can_merge(prev_class, pages_per_zspage, objs_per_zspage)) {
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002496 pool->size_class[i] = prev_class;
2497 continue;
2498 }
2499 }
2500
2501 class = kzalloc(sizeof(struct size_class), GFP_KERNEL);
2502 if (!class)
2503 goto err;
2504
Nitin Gupta61989a82012-01-09 16:51:56 -06002505 class->size = size;
2506 class->index = i;
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002507 class->pages_per_zspage = pages_per_zspage;
Ganesh Mahendran64d90462016-07-28 15:47:51 -07002508 class->objs_per_zspage = objs_per_zspage;
Nitin Gupta61989a82012-01-09 16:51:56 -06002509 spin_lock_init(&class->lock);
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002510 pool->size_class[i] = class;
Minchan Kim48b48002016-07-26 15:23:31 -07002511 for (fullness = ZS_EMPTY; fullness < NR_ZS_FULLNESS;
2512 fullness++)
Minchan Kim37836892016-07-26 15:23:23 -07002513 INIT_LIST_HEAD(&class->fullness_list[fullness]);
Ganesh Mahendrandf8b5bb2014-12-12 16:57:07 -08002514
2515 prev_class = class;
Nitin Gupta61989a82012-01-09 16:51:56 -06002516 }
2517
Dan Streetmand34f6152016-05-20 16:59:56 -07002518 /* debug only, don't abort if it fails */
2519 zs_pool_stat_create(pool, name);
Ganesh Mahendran0f050d92015-02-12 15:00:54 -08002520
Minchan Kim48b48002016-07-26 15:23:31 -07002521 if (zs_register_migration(pool))
2522 goto err;
2523
Sergey Senozhatskyab9d3062015-09-08 15:04:41 -07002524 /*
Aliaksei Karaliou93144ca2018-01-31 16:18:40 -08002525 * Not critical since shrinker is only used to trigger internal
2526 * defragmentation of the pool which is pretty optional thing. If
2527 * registration fails we still can use the pool normally and user can
2528 * trigger compaction manually. Thus, ignore return code.
Sergey Senozhatskyab9d3062015-09-08 15:04:41 -07002529 */
Aliaksei Karaliou93144ca2018-01-31 16:18:40 -08002530 zs_register_shrinker(pool);
2531
Nitin Gupta61989a82012-01-09 16:51:56 -06002532 return pool;
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002533
2534err:
2535 zs_destroy_pool(pool);
2536 return NULL;
Nitin Gupta61989a82012-01-09 16:51:56 -06002537}
2538EXPORT_SYMBOL_GPL(zs_create_pool);
2539
2540void zs_destroy_pool(struct zs_pool *pool)
2541{
2542 int i;
2543
Sergey Senozhatskyab9d3062015-09-08 15:04:41 -07002544 zs_unregister_shrinker(pool);
Minchan Kim48b48002016-07-26 15:23:31 -07002545 zs_unregister_migration(pool);
Ganesh Mahendran0f050d92015-02-12 15:00:54 -08002546 zs_pool_stat_destroy(pool);
2547
Jerome Marchandcf8e0fe2017-07-10 15:50:18 -07002548 for (i = 0; i < ZS_SIZE_CLASSES; i++) {
Nitin Gupta61989a82012-01-09 16:51:56 -06002549 int fg;
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002550 struct size_class *class = pool->size_class[i];
2551
2552 if (!class)
2553 continue;
2554
2555 if (class->index != i)
2556 continue;
Nitin Gupta61989a82012-01-09 16:51:56 -06002557
Minchan Kim48b48002016-07-26 15:23:31 -07002558 for (fg = ZS_EMPTY; fg < NR_ZS_FULLNESS; fg++) {
Minchan Kim37836892016-07-26 15:23:23 -07002559 if (!list_empty(&class->fullness_list[fg])) {
Marlies Ruck93ad5ab2013-05-15 16:56:49 -04002560 pr_info("Freeing non-empty class with size %db, fullness group %d\n",
Nitin Gupta61989a82012-01-09 16:51:56 -06002561 class->size, fg);
2562 }
2563 }
Joonsoo Kim9eec4cd2014-12-12 16:56:44 -08002564 kfree(class);
Nitin Gupta61989a82012-01-09 16:51:56 -06002565 }
Mahendran Ganesh40f9fb82014-12-12 16:57:01 -08002566
Minchan Kim37836892016-07-26 15:23:23 -07002567 destroy_cache(pool);
Ganesh Mahendran0f050d92015-02-12 15:00:54 -08002568 kfree(pool->name);
Nitin Gupta61989a82012-01-09 16:51:56 -06002569 kfree(pool);
2570}
2571EXPORT_SYMBOL_GPL(zs_destroy_pool);
2572
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08002573static int __init zs_init(void)
Nitin Gupta61989a82012-01-09 16:51:56 -06002574{
Minchan Kim48b48002016-07-26 15:23:31 -07002575 int ret;
2576
2577 ret = zsmalloc_mount();
2578 if (ret)
2579 goto out;
2580
Sebastian Andrzej Siewior215c89d2016-11-27 00:13:38 +01002581 ret = cpuhp_setup_state(CPUHP_MM_ZS_PREPARE, "mm/zsmalloc:prepare",
2582 zs_cpu_prepare, zs_cpu_dead);
Ganesh Mahendran0f050d92015-02-12 15:00:54 -08002583 if (ret)
Sebastian Andrzej Siewior215c89d2016-11-27 00:13:38 +01002584 goto hp_setup_fail;
Nitin Gupta61989a82012-01-09 16:51:56 -06002585
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08002586#ifdef CONFIG_ZPOOL
2587 zpool_register_driver(&zs_zpool_driver);
2588#endif
Ganesh Mahendran0f050d92015-02-12 15:00:54 -08002589
Dan Streetman4abaac92016-05-26 15:16:27 -07002590 zs_stat_init();
2591
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08002592 return 0;
Ganesh Mahendran0f050d92015-02-12 15:00:54 -08002593
Sebastian Andrzej Siewior215c89d2016-11-27 00:13:38 +01002594hp_setup_fail:
Minchan Kim48b48002016-07-26 15:23:31 -07002595 zsmalloc_unmount();
2596out:
Ganesh Mahendran0f050d92015-02-12 15:00:54 -08002597 return ret;
Nitin Gupta61989a82012-01-09 16:51:56 -06002598}
Nitin Gupta61989a82012-01-09 16:51:56 -06002599
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08002600static void __exit zs_exit(void)
Nitin Gupta61989a82012-01-09 16:51:56 -06002601{
Ganesh Mahendran66cdef62014-12-18 16:17:40 -08002602#ifdef CONFIG_ZPOOL
2603 zpool_unregister_driver(&zs_zpool_driver);
2604#endif
Minchan Kim48b48002016-07-26 15:23:31 -07002605 zsmalloc_unmount();
Sebastian Andrzej Siewior215c89d2016-11-27 00:13:38 +01002606 cpuhp_remove_state(CPUHP_MM_ZS_PREPARE);
Ganesh Mahendran0f050d92015-02-12 15:00:54 -08002607
2608 zs_stat_exit();
Nitin Gupta61989a82012-01-09 16:51:56 -06002609}
Ben Hutchings069f1012012-06-20 02:31:11 +01002610
2611module_init(zs_init);
2612module_exit(zs_exit);
2613
2614MODULE_LICENSE("Dual BSD/GPL");
2615MODULE_AUTHOR("Nitin Gupta <ngupta@vflare.org>");