blob: ebb2841f752e8f1ab14a5d573b3303ae356490bd [file] [log] [blame]
Nitin Gupta61989a82012-01-09 16:51:56 -06001/*
2 * zsmalloc memory allocator
3 *
4 * Copyright (C) 2011 Nitin Gupta
Minchan Kim00cfab32014-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
14#ifndef _ZS_MALLOC_H_
15#define _ZS_MALLOC_H_
16
17#include <linux/types.h>
18
Seth Jenningsb7418512012-07-02 16:15:52 -050019/*
20 * zsmalloc mapping modes
21 *
22 * NOTE: These only make a difference when a mapped object spans pages
23*/
24enum zs_mapmode {
25 ZS_MM_RW, /* normal read-write mapping */
26 ZS_MM_RO, /* read-only (no copy-out at unmap time) */
27 ZS_MM_WO /* write-only (no copy-in at map time) */
28};
29
Nitin Gupta61989a82012-01-09 16:51:56 -060030struct zs_pool;
31
Seth Jennings0d145a52013-01-30 09:36:52 -060032struct zs_pool *zs_create_pool(gfp_t flags);
Nitin Gupta61989a82012-01-09 16:51:56 -060033void zs_destroy_pool(struct zs_pool *pool);
34
Minchan Kimc2344342012-06-08 15:39:25 +090035unsigned long zs_malloc(struct zs_pool *pool, size_t size);
36void zs_free(struct zs_pool *pool, unsigned long obj);
Nitin Gupta61989a82012-01-09 16:51:56 -060037
Seth Jenningsb7418512012-07-02 16:15:52 -050038void *zs_map_object(struct zs_pool *pool, unsigned long handle,
39 enum zs_mapmode mm);
Minchan Kimc2344342012-06-08 15:39:25 +090040void zs_unmap_object(struct zs_pool *pool, unsigned long handle);
Nitin Gupta61989a82012-01-09 16:51:56 -060041
Minchan Kim70a5d232014-10-09 15:29:50 -070042unsigned long zs_get_total_pages(struct zs_pool *pool);
Nitin Gupta61989a82012-01-09 16:51:56 -060043
44#endif