staging: ion: refactor ion's heap API into linux/ion.h

 */

#include <linux/device.h>

#include <linux/ion.h>

#include <linux/slab.h>

#include <linux/errno.h>

#include <linux/err.h>

#include <linux/scatterlist.h>

#include <linux/highmem.h>

#include "../ion.h"

struct ion_cma_heap {

	struct ion_heap heap;

	struct cma *cma;

#include <linux/dma-mapping.h>

#include <linux/err.h>

#include <linux/highmem.h>

#include <linux/ion.h>

#include <linux/mm.h>

#include <linux/scatterlist.h>

#include <linux/slab.h>

#include <linux/vmalloc.h>

#include "../ion.h"

#include "ion_page_pool.h"

#define NUM_ORDERS ARRAY_SIZE(orders)

			pr_err("%s: Failed to register shrinker\n", __func__);

	}

	heap->dev = dev;

	heap->num_of_buffers = 0;

	heap->num_of_alloc_bytes = 0;

	heap->alloc_bytes_wm = 0;

/* SPDX-License-Identifier: GPL-2.0 */

/*

 * ION Memory Allocator kernel interface header

 *

 * Copyright (C) 2011 Google, Inc.

 */

#ifndef _ION_H

#define _ION_H

#include <linux/device.h>

#include <linux/dma-direction.h>

#include <linux/kref.h>

#include <linux/mm_types.h>

#include <linux/mutex.h>

#include <linux/rbtree.h>

#include <linux/sched.h>

#include <linux/shrinker.h>

#include <linux/types.h>

#include "../uapi/ion.h"

/**

 * struct ion_buffer - metadata for a particular buffer

 * @node:		node in the ion_device buffers tree

 * @list:		element in list of deferred freeable buffers

 * @dev:		back pointer to the ion_device

 * @heap:		back pointer to the heap the buffer came from

 * @flags:		buffer specific flags

 * @private_flags:	internal buffer specific flags

 * @size:		size of the buffer

 * @priv_virt:		private data to the buffer representable as

 *			a void *

 * @lock:		protects the buffers cnt fields

 * @kmap_cnt:		number of times the buffer is mapped to the kernel

 * @vaddr:		the kernel mapping if kmap_cnt is not zero

 * @sg_table:		the sg table for the buffer

 * @attachments:	list of devices attached to this buffer

 */

struct ion_buffer {

	union {

		struct rb_node node;

		struct list_head list;

	};

	struct ion_heap *heap;

	unsigned long flags;

	unsigned long private_flags;

	size_t size;

	void *priv_virt;

	struct mutex lock;

	int kmap_cnt;

	void *vaddr;

	struct sg_table *sg_table;

	struct list_head attachments;

};

/**

 * struct ion_heap_ops - ops to operate on a given heap

 * @allocate:		allocate memory

 * @free:		free memory

 * @map_kernel		map memory to the kernel

 * @unmap_kernel	unmap memory to the kernel

 * @map_user		map memory to userspace

 *

 * allocate, phys, and map_user return 0 on success, -errno on error.

 * map_dma and map_kernel return pointer on success, ERR_PTR on

 * error. @free will be called with ION_PRIV_FLAG_SHRINKER_FREE set in

 * the buffer's private_flags when called from a shrinker. In that

 * case, the pages being free'd must be truly free'd back to the

 * system, not put in a page pool or otherwise cached.

 */

struct ion_heap_ops {

	int (*allocate)(struct ion_heap *heap,

			struct ion_buffer *buffer, unsigned long len,

			unsigned long flags);

	void (*free)(struct ion_buffer *buffer);

	void * (*map_kernel)(struct ion_heap *heap, struct ion_buffer *buffer);

	void (*unmap_kernel)(struct ion_heap *heap, struct ion_buffer *buffer);

	int (*map_user)(struct ion_heap *mapper, struct ion_buffer *buffer,

			struct vm_area_struct *vma);

	int (*shrink)(struct ion_heap *heap, gfp_t gfp_mask, int nr_to_scan);

};

/**

 * heap flags - flags between the heaps and core ion code

 */

#define ION_HEAP_FLAG_DEFER_FREE BIT(0)

/**

 * private flags - flags internal to ion

 */

/*

 * Buffer is being freed from a shrinker function. Skip any possible

 * heap-specific caching mechanism (e.g. page pools). Guarantees that

 * any buffer storage that came from the system allocator will be

 * returned to the system allocator.

 */

#define ION_PRIV_FLAG_SHRINKER_FREE BIT(0)

/**

 * struct ion_heap - represents a heap in the system

 * @node:		rb node to put the heap on the device's tree of heaps

 * @dev:		back pointer to the ion_device

 * @type:		type of heap

 * @ops:		ops struct as above

 * @flags:		flags

 * @id:			id of heap, also indicates priority of this heap when

 *			allocating.  These are specified by platform data and

 *			MUST be unique

 * @name:		used for debugging

 * @shrinker:		a shrinker for the heap

 * @free_list:		free list head if deferred free is used

 * @free_list_size	size of the deferred free list in bytes

 * @lock:		protects the free list

 * @waitqueue:		queue to wait on from deferred free thread

 * @task:		task struct of deferred free thread

 * @num_of_buffers	the number of currently allocated buffers

 * @num_of_alloc_bytes	the number of allocated bytes

 * @alloc_bytes_wm	the number of allocated bytes watermark

 *

 * Represents a pool of memory from which buffers can be made.  In some

 * systems the only heap is regular system memory allocated via vmalloc.

 * On others, some blocks might require large physically contiguous buffers

 * that are allocated from a specially reserved heap.

 */

struct ion_heap {

	struct plist_node node;

	struct ion_device *dev;

	enum ion_heap_type type;

	struct ion_heap_ops *ops;

	unsigned long flags;

	unsigned int id;

	const char *name;

	/* deferred free support */

	struct shrinker shrinker;

	struct list_head free_list;

	size_t free_list_size;

	spinlock_t free_lock;

	wait_queue_head_t waitqueue;

	struct task_struct *task;

	/* heap statistics */

	u64 num_of_buffers;

	u64 num_of_alloc_bytes;

	u64 alloc_bytes_wm;

	/* protect heap statistics */

	spinlock_t stat_lock;

};

/**

 * ion_device_add_heap - adds a heap to the ion device

 * @heap:		the heap to add

 */

void ion_device_add_heap(struct ion_heap *heap);

/* ion_buffer_zero - zeroes out an ion buffer respecting the ION_FLAGs.

 *

 * @buffer:		ion_buffer to zero

 *

 * Returns 0 on success, negative error otherwise.

 */

int ion_buffer_zero(struct ion_buffer *buffer);

/**

 * some helpers for common operations on buffers using the sg_table

 * and vaddr fields

 */

void *ion_heap_map_kernel(struct ion_heap *heap, struct ion_buffer *buffer);

void ion_heap_unmap_kernel(struct ion_heap *heap, struct ion_buffer *buffer);

int ion_heap_map_user(struct ion_heap *heap, struct ion_buffer *buffer,

		      struct vm_area_struct *vma);

int ion_heap_pages_zero(struct page *page, size_t size, pgprot_t pgprot);

int ion_heap_sglist_zero(struct scatterlist *sgl, unsigned int nents,

			 pgprot_t pgprot);

/**

 * ion_heap_init_shrinker

 * @heap:		the heap

 *

 * If a heap sets the ION_HEAP_FLAG_DEFER_FREE flag or defines the shrink op

 * this function will be called to setup a shrinker to shrink the freelists

 * and call the heap's shrink op.

 */

int ion_heap_init_shrinker(struct ion_heap *heap);

/**

 * ion_heap_init_deferred_free -- initialize deferred free functionality

 * @heap:		the heap

 *

 * If a heap sets the ION_HEAP_FLAG_DEFER_FREE flag this function will

 * be called to setup deferred frees. Calls to free the buffer will

 * return immediately and the actual free will occur some time later

 */

int ion_heap_init_deferred_free(struct ion_heap *heap);

/**

 * ion_heap_freelist_add - add a buffer to the deferred free list

 * @heap:		the heap

 * @buffer:		the buffer

 *

 * Adds an item to the deferred freelist.

 */

void ion_heap_freelist_add(struct ion_heap *heap, struct ion_buffer *buffer);

/**

 * ion_heap_freelist_drain - drain the deferred free list

 * @heap:		the heap

 * @size:		amount of memory to drain in bytes

 *

 * Drains the indicated amount of memory from the deferred freelist immediately.

 * Returns the total amount freed.  The total freed may be higher depending

 * on the size of the items in the list, or lower if there is insufficient

 * total memory on the freelist.

 */

size_t ion_heap_freelist_drain(struct ion_heap *heap, size_t size);

/**

 * ion_heap_freelist_shrink - drain the deferred free

 *				list, skipping any heap-specific

 *				pooling or caching mechanisms

 *

 * @heap:		the heap

 * @size:		amount of memory to drain in bytes

 *

 * Drains the indicated amount of memory from the deferred freelist immediately.

 * Returns the total amount freed.  The total freed may be higher depending

 * on the size of the items in the list, or lower if there is insufficient

 * total memory on the freelist.

 *

 * Unlike with @ion_heap_freelist_drain, don't put any pages back into

 * page pools or otherwise cache the pages. Everything must be

 * genuinely free'd back to the system. If you're free'ing from a

 * shrinker you probably want to use this. Note that this relies on

 * the heap.ops.free callback honoring the ION_PRIV_FLAG_SHRINKER_FREE

 * flag.

 */

size_t ion_heap_freelist_shrink(struct ion_heap *heap,

				size_t size);

/**

 * ion_heap_freelist_size - returns the size of the freelist in bytes

 * @heap:		the heap

 */

size_t ion_heap_freelist_size(struct ion_heap *heap);

#endif /* _ION_H */

	return ERR_PTR(ret);

}

static int ion_clear_pages(struct page **pages, int num, pgprot_t pgprot)

{

	void *addr = vm_map_ram(pages, num, -1, pgprot);

	if (!addr)

		return -ENOMEM;

	memset(addr, 0, PAGE_SIZE * num);

	vm_unmap_ram(addr, num);

	return 0;

}

static int ion_sglist_zero(struct scatterlist *sgl, unsigned int nents,

			   pgprot_t pgprot)

{

	int p = 0;

	int ret = 0;

	struct sg_page_iter piter;

	struct page *pages[32];

	for_each_sg_page(sgl, &piter, nents, 0) {

		pages[p++] = sg_page_iter_page(&piter);

		if (p == ARRAY_SIZE(pages)) {

			ret = ion_clear_pages(pages, p, pgprot);

			if (ret)

				return ret;

			p = 0;

		}

	}

	if (p)

		ret = ion_clear_pages(pages, p, pgprot);

	return ret;

}

struct ion_buffer *ion_buffer_alloc(struct ion_device *dev, size_t len,

				    unsigned int heap_id_mask,

				    unsigned int flags)

	else

		pgprot = pgprot_writecombine(PAGE_KERNEL);

	return ion_heap_sglist_zero(table->sgl, table->nents, pgprot);

	return ion_sglist_zero(table->sgl, table->nents, pgprot);

}

void ion_buffer_release(struct ion_buffer *buffer)