LXR linux/include/linux/zsmalloc.h

   1/*
   2 * zsmalloc memory allocator
   3 *
   4 * Copyright (C) 2011  Nitin Gupta
   5 * Copyright (C) 2012, 2013 Minchan Kim
   6 *
   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
  19/*
  20 * zsmalloc mapping modes
  21 *
  22 * NOTE: These only make a difference when a mapped object spans pages.
  23 * They also have no effect when PGTABLE_MAPPING is selected.
  24 */
  25enum zs_mapmode {
  26        ZS_MM_RW, /* normal read-write mapping */
  27        ZS_MM_RO, /* read-only (no copy-out at unmap time) */
  28        ZS_MM_WO /* write-only (no copy-in at map time) */
  29        /*
  30         * NOTE: ZS_MM_WO should only be used for initializing new
  31         * (uninitialized) allocations.  Partial writes to already
  32         * initialized allocations should use ZS_MM_RW to preserve the
  33         * existing data.
  34         */
  35};
  36
  37struct zs_pool;
  38
  39struct zs_pool *zs_create_pool(gfp_t flags);
  40void zs_destroy_pool(struct zs_pool *pool);
  41
  42unsigned long zs_malloc(struct zs_pool *pool, size_t size);
  43void zs_free(struct zs_pool *pool, unsigned long obj);
  44
  45void *zs_map_object(struct zs_pool *pool, unsigned long handle,
  46                        enum zs_mapmode mm);
  47void zs_unmap_object(struct zs_pool *pool, unsigned long handle);
  48
  49u64 zs_get_total_size_bytes(struct zs_pool *pool);
  50
  51#endif
  52