[linux-2.6-block.git] / drivers / android / binder_alloc.h

/* SPDX-License-Identifier: GPL-2.0-only */
/*
 * Copyright (C) 2017 Google, Inc.
 */

#ifndef _LINUX_BINDER_ALLOC_H
#define _LINUX_BINDER_ALLOC_H

#include <linux/rbtree.h>
#include <linux/list.h>
#include <linux/mm.h>
#include <linux/rtmutex.h>
#include <linux/vmalloc.h>
#include <linux/slab.h>
#include <linux/list_lru.h>
#include <uapi/linux/android/binder.h>

extern struct list_lru binder_alloc_lru;
struct binder_transaction;

/**
 * struct binder_buffer - buffer used for binder transactions
 * @entry:              entry alloc->buffers
 * @rb_node:            node for allocated_buffers/free_buffers rb trees
 * @free:               %true if buffer is free
 * @allow_user_free:    %true if user is allowed to free buffer
 * @async_transaction:  %true if buffer is in use for an async txn
 * @debug_id:           unique ID for debugging
 * @transaction:        pointer to associated struct binder_transaction
 * @target_node:        struct binder_node associated with this buffer
 * @data_size:          size of @transaction data
 * @offsets_size:       size of array of offsets
 * @extra_buffers_size: size of space for other objects (like sg lists)
 * @user_data:          user pointer to base of buffer space
 *
 * Bookkeeping structure for binder transaction buffers
 */
struct binder_buffer {
	struct list_head entry; /* free and allocated entries by address */
	struct rb_node rb_node; /* free entry by size or allocated entry */
				/* by address */
	unsigned free:1;
	unsigned allow_user_free:1;
	unsigned async_transaction:1;
	unsigned debug_id:29;

	struct binder_transaction *transaction;

	struct binder_node *target_node;
	size_t data_size;
	size_t offsets_size;
	size_t extra_buffers_size;
	void __user *user_data;
};

/**
 * struct binder_lru_page - page object used for binder shrinker
 * @page_ptr: pointer to physical page in mmap'd space
 * @lru:      entry in binder_alloc_lru
 * @alloc:    binder_alloc for a proc
 */
struct binder_lru_page {
	struct list_head lru;
	struct page *page_ptr;
	struct binder_alloc *alloc;
};

/**
 * struct binder_alloc - per-binder proc state for binder allocator
 * @vma:                vm_area_struct passed to mmap_handler
 *                      (invarient after mmap)
 * @tsk:                tid for task that called init for this proc
 *                      (invariant after init)
 * @vma_vm_mm:          copy of vma->vm_mm (invarient after mmap)
 * @buffer:             base of per-proc address space mapped via mmap
 * @buffers:            list of all buffers for this proc
 * @free_buffers:       rb tree of buffers available for allocation
 *                      sorted by size
 * @allocated_buffers:  rb tree of allocated buffers sorted by address
 * @free_async_space:   VA space available for async buffers. This is
 *                      initialized at mmap time to 1/2 the full VA space
 * @pages:              array of binder_lru_page
 * @buffer_size:        size of address space specified via mmap
 * @pid:                pid for associated binder_proc (invariant after init)
 * @pages_high:         high watermark of offset in @pages
 *
 * Bookkeeping structure for per-proc address space management for binder
 * buffers. It is normally initialized during binder_init() and binder_mmap()
 * calls. The address space is used for both user-visible buffers and for
 * struct binder_buffer objects used to track the user buffers
 */
struct binder_alloc {
	struct mutex mutex;
	struct vm_area_struct *vma;
	struct mm_struct *vma_vm_mm;
	void __user *buffer;
	struct list_head buffers;
	struct rb_root free_buffers;
	struct rb_root allocated_buffers;
	size_t free_async_space;
	struct binder_lru_page *pages;
	size_t buffer_size;
	uint32_t buffer_free;
	int pid;
	size_t pages_high;
};

#ifdef CONFIG_ANDROID_BINDER_IPC_SELFTEST
void binder_selftest_alloc(struct binder_alloc *alloc);
#else
static inline void binder_selftest_alloc(struct binder_alloc *alloc) {}
#endif
enum lru_status binder_alloc_free_page(struct list_head *item,
				       struct list_lru_one *lru,
				       spinlock_t *lock, void *cb_arg);
extern struct binder_buffer *binder_alloc_new_buf(struct binder_alloc *alloc,
						  size_t data_size,
						  size_t offsets_size,
						  size_t extra_buffers_size,
						  int is_async);
extern void binder_alloc_init(struct binder_alloc *alloc);
extern int binder_alloc_shrinker_init(void);
extern void binder_alloc_vma_close(struct binder_alloc *alloc);
extern struct binder_buffer *
binder_alloc_prepare_to_free(struct binder_alloc *alloc,
			     uintptr_t user_ptr);
extern void binder_alloc_free_buf(struct binder_alloc *alloc,
				  struct binder_buffer *buffer);
extern int binder_alloc_mmap_handler(struct binder_alloc *alloc,
				     struct vm_area_struct *vma);
extern void binder_alloc_deferred_release(struct binder_alloc *alloc);
extern int binder_alloc_get_allocated_count(struct binder_alloc *alloc);
extern void binder_alloc_print_allocated(struct seq_file *m,
					 struct binder_alloc *alloc);
void binder_alloc_print_pages(struct seq_file *m,
			      struct binder_alloc *alloc);

/**
 * binder_alloc_get_free_async_space() - get free space available for async
 * @alloc:	binder_alloc for this proc
 *
 * Return:	the bytes remaining in the address-space for async transactions
 */
static inline size_t
binder_alloc_get_free_async_space(struct binder_alloc *alloc)
{
	size_t free_async_space;

	mutex_lock(&alloc->mutex);
	free_async_space = alloc->free_async_space;
	mutex_unlock(&alloc->mutex);
	return free_async_space;
}

unsigned long
binder_alloc_copy_user_to_buffer(struct binder_alloc *alloc,
				 struct binder_buffer *buffer,
				 binder_size_t buffer_offset,
				 const void __user *from,
				 size_t bytes);

int binder_alloc_copy_to_buffer(struct binder_alloc *alloc,
				struct binder_buffer *buffer,
				binder_size_t buffer_offset,
				void *src,
				size_t bytes);

int binder_alloc_copy_from_buffer(struct binder_alloc *alloc,
				  void *dest,
				  struct binder_buffer *buffer,
				  binder_size_t buffer_offset,
				  size_t bytes);

#endif /* _LINUX_BINDER_ALLOC_H */
Commit	Line	Data
9c92ab61	1	/* SPDX-License-Identifier: GPL-2.0-only */
0c972a05 TK	2	/*
0c972a05 TK	3	* Copyright (C) 2017 Google, Inc.
0c972a05 TK	4	*/
	5
	6	#ifndef _LINUX_BINDER_ALLOC_H
	7	#define _LINUX_BINDER_ALLOC_H
	8
	9	#include <linux/rbtree.h>
	10	#include <linux/list.h>
	11	#include <linux/mm.h>
	12	#include <linux/rtmutex.h>
	13	#include <linux/vmalloc.h>
	14	#include <linux/slab.h>
f2517eb7	15	#include <linux/list_lru.h>
1a7c3d9b	16	#include <uapi/linux/android/binder.h>
0c972a05	17
f2517eb7	18	extern struct list_lru binder_alloc_lru;
0c972a05 TK	19	struct binder_transaction;
	20
	21	/**
	22	* struct binder_buffer - buffer used for binder transactions
	23	* @entry: entry alloc->buffers
	24	* @rb_node: node for allocated_buffers/free_buffers rb trees
7a2670a5 TK	25	* @free: %true if buffer is free
	26	* @allow_user_free: %true if user is allowed to free buffer
	27	* @async_transaction: %true if buffer is in use for an async txn
	28	* @debug_id: unique ID for debugging
	29	* @transaction: pointer to associated struct binder_transaction
	30	* @target_node: struct binder_node associated with this buffer
	31	* @data_size: size of @transaction data
	32	* @offsets_size: size of array of offsets
	33	* @extra_buffers_size: size of space for other objects (like sg lists)
bde4a19f	34	* @user_data: user pointer to base of buffer space
0c972a05 TK	35	*
	36	* Bookkeeping structure for binder transaction buffers
	37	*/
	38	struct binder_buffer {
	39	struct list_head entry; /* free and allocated entries by address */
	40	struct rb_node rb_node; /* free entry by size or allocated entry */
	41	/* by address */
	42	unsigned free:1;
	43	unsigned allow_user_free:1;
	44	unsigned async_transaction:1;
7bada55a	45	unsigned debug_id:29;
0c972a05 TK	46
	47	struct binder_transaction *transaction;
	48
	49	struct binder_node *target_node;
	50	size_t data_size;
	51	size_t offsets_size;
	52	size_t extra_buffers_size;
bde4a19f	53	void __user *user_data;
0c972a05 TK	54	};
0c972a05 TK	55
f2517eb7 SY	56	/**
	57	* struct binder_lru_page - page object used for binder shrinker
	58	* @page_ptr: pointer to physical page in mmap'd space
	59	* @lru: entry in binder_alloc_lru
	60	* @alloc: binder_alloc for a proc
	61	*/
	62	struct binder_lru_page {
	63	struct list_head lru;
	64	struct page *page_ptr;
	65	struct binder_alloc *alloc;
	66	};
	67
0c972a05 TK	68	/**
	69	* struct binder_alloc - per-binder proc state for binder allocator
	70	* @vma: vm_area_struct passed to mmap_handler
	71	* (invarient after mmap)
	72	* @tsk: tid for task that called init for this proc
	73	* (invariant after init)
	74	* @vma_vm_mm: copy of vma->vm_mm (invarient after mmap)
	75	* @buffer: base of per-proc address space mapped via mmap
0c972a05 TK	76	* @buffers: list of all buffers for this proc
	77	* @free_buffers: rb tree of buffers available for allocation
	78	* sorted by size
	79	* @allocated_buffers: rb tree of allocated buffers sorted by address
	80	* @free_async_space: VA space available for async buffers. This is
	81	* initialized at mmap time to 1/2 the full VA space
f2517eb7	82	* @pages: array of binder_lru_page
0c972a05 TK	83	* @buffer_size: size of address space specified via mmap
0c972a05 TK	84	* @pid: pid for associated binder_proc (invariant after init)
8d9a3ab6	85	* @pages_high: high watermark of offset in @pages
0c972a05 TK	86	*
	87	* Bookkeeping structure for per-proc address space management for binder
	88	* buffers. It is normally initialized during binder_init() and binder_mmap()
	89	* calls. The address space is used for both user-visible buffers and for
	90	* struct binder_buffer objects used to track the user buffers
	91	*/
	92	struct binder_alloc {
	93	struct mutex mutex;
0c972a05 TK	94	struct vm_area_struct *vma;
0c972a05 TK	95	struct mm_struct *vma_vm_mm;
bde4a19f	96	void __user *buffer;
0c972a05 TK	97	struct list_head buffers;
	98	struct rb_root free_buffers;
	99	struct rb_root allocated_buffers;
	100	size_t free_async_space;
f2517eb7	101	struct binder_lru_page *pages;
0c972a05 TK	102	size_t buffer_size;
	103	uint32_t buffer_free;
	104	int pid;
8d9a3ab6	105	size_t pages_high;
0c972a05 TK	106	};
0c972a05 TK	107
4175e2b4 SY	108	#ifdef CONFIG_ANDROID_BINDER_IPC_SELFTEST
	109	void binder_selftest_alloc(struct binder_alloc *alloc);
	110	#else
	111	static inline void binder_selftest_alloc(struct binder_alloc *alloc) {}
	112	#endif
f2517eb7 SY	113	enum lru_status binder_alloc_free_page(struct list_head *item,
	114	struct list_lru_one *lru,
	115	spinlock_t lock, void cb_arg);
0c972a05 TK	116	extern struct binder_buffer binder_alloc_new_buf(struct binder_alloc alloc,
	117	size_t data_size,
	118	size_t offsets_size,
	119	size_t extra_buffers_size,
	120	int is_async);
	121	extern void binder_alloc_init(struct binder_alloc *alloc);
533dfb25	122	extern int binder_alloc_shrinker_init(void);
0c972a05 TK	123	extern void binder_alloc_vma_close(struct binder_alloc *alloc);
0c972a05 TK	124	extern struct binder_buffer *
53d311cf TK	125	binder_alloc_prepare_to_free(struct binder_alloc *alloc,
53d311cf TK	126	uintptr_t user_ptr);
0c972a05 TK	127	extern void binder_alloc_free_buf(struct binder_alloc *alloc,
	128	struct binder_buffer *buffer);
	129	extern int binder_alloc_mmap_handler(struct binder_alloc *alloc,
	130	struct vm_area_struct *vma);
	131	extern void binder_alloc_deferred_release(struct binder_alloc *alloc);
	132	extern int binder_alloc_get_allocated_count(struct binder_alloc *alloc);
	133	extern void binder_alloc_print_allocated(struct seq_file *m,
	134	struct binder_alloc *alloc);
8ef4665a SY	135	void binder_alloc_print_pages(struct seq_file *m,
8ef4665a SY	136	struct binder_alloc *alloc);
0c972a05 TK	137
	138	/**
	139	* binder_alloc_get_free_async_space() - get free space available for async
	140	* @alloc: binder_alloc for this proc
	141	*
	142	* Return: the bytes remaining in the address-space for async transactions
	143	*/
	144	static inline size_t
	145	binder_alloc_get_free_async_space(struct binder_alloc *alloc)
	146	{
	147	size_t free_async_space;
	148
	149	mutex_lock(&alloc->mutex);
	150	free_async_space = alloc->free_async_space;
	151	mutex_unlock(&alloc->mutex);
	152	return free_async_space;
	153	}
	154
1a7c3d9b TK	155	unsigned long
	156	binder_alloc_copy_user_to_buffer(struct binder_alloc *alloc,
	157	struct binder_buffer *buffer,
	158	binder_size_t buffer_offset,
	159	const void __user *from,
	160	size_t bytes);
	161
bb4a2e48 TK	162	int binder_alloc_copy_to_buffer(struct binder_alloc *alloc,
	163	struct binder_buffer *buffer,
	164	binder_size_t buffer_offset,
	165	void *src,
	166	size_t bytes);
	167
	168	int binder_alloc_copy_from_buffer(struct binder_alloc *alloc,
	169	void *dest,
	170	struct binder_buffer *buffer,
	171	binder_size_t buffer_offset,
	172	size_t bytes);
8ced0c62	173
0c972a05 TK	174	#endif /* _LINUX_BINDER_ALLOC_H */
0c972a05 TK	175