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