drivers/android/binder_alloc.h

   1 /*
   2  * Copyright (C) 2017 Google, Inc.
   3  *
   4  * This software is licensed under the terms of the GNU General Public
   5  * License version 2, as published by the Free Software Foundation, and
   6  * may be copied, distributed, and modified under those terms.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  */
  14
  15 #ifndef _LINUX_BINDER_ALLOC_H
  16 #define _LINUX_BINDER_ALLOC_H
  17
  18 #include <linux/rbtree.h>
  19 #include <linux/list.h>
  20 #include <linux/mm.h>
  21 #include <linux/rtmutex.h>
  22 #include <linux/vmalloc.h>
  23 #include <linux/slab.h>
  24
  25 struct binder_transaction;
  26
  27 /**
  28  * struct binder_buffer - buffer used for binder transactions
  29  * @entry:              entry alloc->buffers
  30  * @rb_node:            node for allocated_buffers/free_buffers rb trees
  31  * @free:               true if buffer is free
  32  * @allow_user_free:    describe the second member of struct blah,
  33  * @async_transaction:  describe the second member of struct blah,
  34  * @debug_id:           describe the second member of struct blah,
  35  * @transaction:        describe the second member of struct blah,
  36  * @target_node:        describe the second member of struct blah,
  37  * @data_size:          describe the second member of struct blah,
  38  * @offsets_size:       describe the second member of struct blah,
  39  * @extra_buffers_size: describe the second member of struct blah,
  40  * @data:i              describe the second member of struct blah,
  41  *
  42  * Bookkeeping structure for binder transaction buffers
  43  */
  44 struct binder_buffer {
  45         struct list_head entry; /* free and allocated entries by address */
  46         struct rb_node rb_node; /* free entry by size or allocated entry */
  47                                 /* by address */
  48         unsigned free:1;
  49         unsigned allow_user_free:1;
  50         unsigned async_transaction:1;
  51         unsigned debug_id:29;
  52
  53         struct binder_transaction *transaction;
  54
  55         struct binder_node *target_node;
  56         size_t data_size;
  57         size_t offsets_size;
  58         size_t extra_buffers_size;
  59         uint8_t data[0];
  60 };
  61
  62 /**
  63  * struct binder_alloc - per-binder proc state for binder allocator
  64  * @vma:                vm_area_struct passed to mmap_handler
  65  *                      (invarient after mmap)
  66  * @tsk:                tid for task that called init for this proc
  67  *                      (invariant after init)
  68  * @vma_vm_mm:          copy of vma->vm_mm (invarient after mmap)
  69  * @buffer:             base of per-proc address space mapped via mmap
  70  * @user_buffer_offset: offset between user and kernel VAs for buffer
  71  * @buffers:            list of all buffers for this proc
  72  * @free_buffers:       rb tree of buffers available for allocation
  73  *                      sorted by size
  74  * @allocated_buffers:  rb tree of allocated buffers sorted by address
  75  * @free_async_space:   VA space available for async buffers. This is
  76  *                      initialized at mmap time to 1/2 the full VA space
  77  * @pages:              array of physical page addresses for each
  78  *                      page of mmap'd space
  79  * @buffer_size:        size of address space specified via mmap
  80  * @pid:                pid for associated binder_proc (invariant after init)
  81  *
  82  * Bookkeeping structure for per-proc address space management for binder
  83  * buffers. It is normally initialized during binder_init() and binder_mmap()
  84  * calls. The address space is used for both user-visible buffers and for
  85  * struct binder_buffer objects used to track the user buffers
  86  */
  87 struct binder_alloc {
  88         struct mutex mutex;
  89         struct task_struct *tsk;
  90         struct vm_area_struct *vma;
  91         struct mm_struct *vma_vm_mm;
  92         void *buffer;
  93         ptrdiff_t user_buffer_offset;
  94         struct list_head buffers;
  95         struct rb_root free_buffers;
  96         struct rb_root allocated_buffers;
  97         size_t free_async_space;
  98         struct page **pages;
  99         size_t buffer_size;
 100         uint32_t buffer_free;
 101         int pid;
 102 };
 103
 104 #ifdef CONFIG_ANDROID_BINDER_IPC_SELFTEST
 105 void binder_selftest_alloc(struct binder_alloc *alloc);
 106 #else
 107 static inline void binder_selftest_alloc(struct binder_alloc *alloc) {}
 108 #endif
 109 extern struct binder_buffer *binder_alloc_new_buf(struct binder_alloc *alloc,
 110                                                   size_t data_size,
 111                                                   size_t offsets_size,
 112                                                   size_t extra_buffers_size,
 113                                                   int is_async);
 114 extern void binder_alloc_init(struct binder_alloc *alloc);
 115 extern void binder_alloc_vma_close(struct binder_alloc *alloc);
 116 extern struct binder_buffer *
 117 binder_alloc_prepare_to_free(struct binder_alloc *alloc,
 118                              uintptr_t user_ptr);
 119 extern void binder_alloc_free_buf(struct binder_alloc *alloc,
 120                                   struct binder_buffer *buffer);
 121 extern int binder_alloc_mmap_handler(struct binder_alloc *alloc,
 122                                      struct vm_area_struct *vma);
 123 extern void binder_alloc_deferred_release(struct binder_alloc *alloc);
 124 extern int binder_alloc_get_allocated_count(struct binder_alloc *alloc);
 125 extern void binder_alloc_print_allocated(struct seq_file *m,
 126                                          struct binder_alloc *alloc);
 127
 128 /**
 129  * binder_alloc_get_free_async_space() - get free space available for async
 130  * @alloc:      binder_alloc for this proc
 131  *
 132  * Return:      the bytes remaining in the address-space for async transactions
 133  */
 134 static inline size_t
 135 binder_alloc_get_free_async_space(struct binder_alloc *alloc)
 136 {
 137         size_t free_async_space;
 138
 139         mutex_lock(&alloc->mutex);
 140         free_async_space = alloc->free_async_space;
 141         mutex_unlock(&alloc->mutex);
 142         return free_async_space;
 143 }
 144
 145 /**
 146  * binder_alloc_get_user_buffer_offset() - get offset between kernel/user addrs
 147  * @alloc:      binder_alloc for this proc
 148  *
 149  * Return:      the offset between kernel and user-space addresses to use for
 150  * virtual address conversion
 151  */
 152 static inline ptrdiff_t
 153 binder_alloc_get_user_buffer_offset(struct binder_alloc *alloc)
 154 {
 155         /*
 156          * user_buffer_offset is constant if vma is set and
 157          * undefined if vma is not set. It is possible to
 158          * get here with !alloc->vma if the target process
 159          * is dying while a transaction is being initiated.
 160          * Returning the old value is ok in this case and
 161          * the transaction will fail.
 162          */
 163         return alloc->user_buffer_offset;
 164 }
 165
 166 #endif /* _LINUX_BINDER_ALLOC_H */
 167