amdgpu: validate the upper limit of virtual address v2
[platform/upstream/libdrm.git] / amdgpu / amdgpu_internal.h
1 /*
2  * Copyright © 2014 Advanced Micro Devices, Inc.
3  * All Rights Reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21  * OTHER DEALINGS IN THE SOFTWARE.
22  */
23
24 #ifndef _AMDGPU_INTERNAL_H_
25 #define _AMDGPU_INTERNAL_H_
26
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <assert.h>
32 #include <pthread.h>
33 #include "xf86atomic.h"
34 #include "amdgpu.h"
35 #include "util_double_list.h"
36
37 #define AMDGPU_CS_MAX_RINGS 8
38 /* do not use below macro if b is not power of 2 aligned value */
39 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
40 #define ROUND_UP(x, y) ((((x)-1) | __round_mask(x, y))+1)
41 #define ROUND_DOWN(x, y) ((x) & ~__round_mask(x, y))
42
43 #define AMDGPU_INVALID_VA_ADDRESS       0xffffffffffffffff
44
45 struct amdgpu_bo_va_hole {
46         struct list_head list;
47         uint64_t offset;
48         uint64_t size;
49 };
50
51 struct amdgpu_bo_va_mgr {
52         /* the start virtual address */
53         uint64_t va_offset;
54         uint64_t va_max;
55         struct list_head va_holes;
56         pthread_mutex_t bo_va_mutex;
57         uint32_t va_alignment;
58 };
59
60 struct amdgpu_device {
61         atomic_t refcount;
62         int fd;
63         int flink_fd;
64         unsigned major_version;
65         unsigned minor_version;
66
67         /** List of buffer handles. Protected by bo_table_mutex. */
68         struct util_hash_table *bo_handles;
69         /** List of buffer GEM flink names. Protected by bo_table_mutex. */
70         struct util_hash_table *bo_flink_names;
71         /** List of buffer virtual memory ranges. Protected by bo_table_mutex. */
72         struct util_hash_table *bo_vas;
73         /** This protects all hash tables. */
74         pthread_mutex_t bo_table_mutex;
75         struct amdgpu_bo_va_mgr vamgr;
76         struct drm_amdgpu_info_device dev_info;
77         struct amdgpu_gpu_info info;
78 };
79
80 struct amdgpu_bo {
81         atomic_t refcount;
82         struct amdgpu_device *dev;
83
84         uint64_t alloc_size;
85         uint64_t virtual_mc_base_address;
86
87         uint32_t handle;
88         uint32_t flink_name;
89
90         pthread_mutex_t cpu_access_mutex;
91         void *cpu_ptr;
92         int cpu_map_count;
93 };
94
95 struct amdgpu_bo_list {
96         struct amdgpu_device *dev;
97
98         uint32_t handle;
99 };
100
101 /*
102  * There are three mutexes.
103  * To avoid deadlock, only hold the mutexes in this order:
104  * sequence_mutex -> pendings_mutex -> pool_mutex.
105 */
106 struct amdgpu_context {
107         struct amdgpu_device *dev;
108         /** Mutex for accessing fences and to maintain command submissions
109             and pending lists in good sequence. */
110         pthread_mutex_t sequence_mutex;
111         /** Buffer for user fences */
112         struct amdgpu_ib *fence_ib;
113         /** The newest expired fence for the ring of the ip blocks. */
114         uint64_t expired_fences[AMDGPU_HW_IP_NUM][AMDGPU_HW_IP_INSTANCE_MAX_COUNT][AMDGPU_CS_MAX_RINGS];
115         /** Mutex for accessing pendings list. */
116         pthread_mutex_t pendings_mutex;
117         /** Pending IBs. */
118         struct list_head pendings[AMDGPU_HW_IP_NUM][AMDGPU_HW_IP_INSTANCE_MAX_COUNT][AMDGPU_CS_MAX_RINGS];
119         /** Freed IBs not yet in pool */
120         struct list_head freed;
121         /** Mutex for accessing free ib pool. */
122         pthread_mutex_t pool_mutex;
123         /** Internal free IB pools. */
124         struct list_head ib_pools[AMDGPU_CS_IB_SIZE_NUM];
125         /* context id*/
126         uint32_t id;
127 };
128
129 struct amdgpu_ib {
130         amdgpu_context_handle context;
131         struct list_head list_node;
132         amdgpu_bo_handle buf_handle;
133         void *cpu;
134         uint64_t virtual_mc_base_address;
135         enum amdgpu_cs_ib_size ib_size;
136         uint64_t cs_handle;
137 };
138
139 /**
140  * Functions.
141  */
142
143 void amdgpu_device_free_internal(amdgpu_device_handle dev);
144
145 void amdgpu_bo_free_internal(amdgpu_bo_handle bo);
146
147 void amdgpu_vamgr_init(struct amdgpu_device *dev);
148
149 uint64_t amdgpu_vamgr_find_va(struct amdgpu_bo_va_mgr *mgr,
150                                uint64_t size, uint64_t alignment);
151
152 void amdgpu_vamgr_free_va(struct amdgpu_bo_va_mgr *mgr, uint64_t va,
153                            uint64_t size);
154
155 int amdgpu_query_gpu_info_init(amdgpu_device_handle dev);
156
157 uint64_t amdgpu_cs_calculate_timeout(uint64_t timeout);
158
159 /**
160  * Inline functions.
161  */
162
163 /**
164  * Increment src and decrement dst as if we were updating references
165  * for an assignment between 2 pointers of some objects.
166  *
167  * \return  true if dst is 0
168  */
169 static inline bool update_references(atomic_t *dst, atomic_t *src)
170 {
171         if (dst != src) {
172                 /* bump src first */
173                 if (src) {
174                         assert(atomic_read(src) > 0);
175                         atomic_inc(src);
176                 }
177                 if (dst) {
178                         assert(atomic_read(dst) > 0);
179                         return atomic_dec_and_test(dst);
180                 }
181         }
182         return false;
183 }
184
185 /**
186  * Assignment between two amdgpu_bo pointers with reference counting.
187  *
188  * Usage:
189  *    struct amdgpu_bo *dst = ... , *src = ...;
190  *
191  *    dst = src;
192  *    // No reference counting. Only use this when you need to move
193  *    // a reference from one pointer to another.
194  *
195  *    amdgpu_bo_reference(&dst, src);
196  *    // Reference counters are updated. dst is decremented and src is
197  *    // incremented. dst is freed if its reference counter is 0.
198  */
199 static inline void amdgpu_bo_reference(struct amdgpu_bo **dst,
200                                         struct amdgpu_bo *src)
201 {
202         if (update_references(&(*dst)->refcount, &src->refcount))
203                 amdgpu_bo_free_internal(*dst);
204         *dst = src;
205 }
206
207 /**
208  * Assignment between two amdgpu_device pointers with reference counting.
209  *
210  * Usage:
211  *    struct amdgpu_device *dst = ... , *src = ...;
212  *
213  *    dst = src;
214  *    // No reference counting. Only use this when you need to move
215  *    // a reference from one pointer to another.
216  *
217  *    amdgpu_device_reference(&dst, src);
218  *    // Reference counters are updated. dst is decremented and src is
219  *    // incremented. dst is freed if its reference counter is 0.
220  */
221 void amdgpu_device_reference(struct amdgpu_device **dst,
222                              struct amdgpu_device *src);
223 #endif