amdgpu: hide the final internal functions from global namespace
[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
25 #ifndef _AMDGPU_INTERNAL_H_
26 #define _AMDGPU_INTERNAL_H_
27
28 #ifdef HAVE_CONFIG_H
29 #include "config.h"
30 #endif
31
32 #include <assert.h>
33 #include <pthread.h>
34
35 #include "libdrm_macros.h"
36 #include "xf86atomic.h"
37 #include "amdgpu.h"
38 #include "util_double_list.h"
39
40 #define AMDGPU_CS_MAX_RINGS 8
41 /* do not use below macro if b is not power of 2 aligned value */
42 #define __round_mask(x, y) ((__typeof__(x))((y)-1))
43 #define ROUND_UP(x, y) ((((x)-1) | __round_mask(x, y))+1)
44 #define ROUND_DOWN(x, y) ((x) & ~__round_mask(x, y))
45
46 #define AMDGPU_INVALID_VA_ADDRESS       0xffffffffffffffff
47
48 struct amdgpu_bo_va_hole {
49         struct list_head list;
50         uint64_t offset;
51         uint64_t size;
52 };
53
54 struct amdgpu_bo_va_mgr {
55         atomic_t refcount;
56         /* the start virtual address */
57         uint64_t va_offset;
58         uint64_t va_max;
59         struct list_head va_holes;
60         pthread_mutex_t bo_va_mutex;
61         uint32_t va_alignment;
62 };
63
64 struct amdgpu_va {
65         amdgpu_device_handle dev;
66         uint64_t address;
67         uint64_t size;
68         enum amdgpu_gpu_va_range range;
69 };
70
71 struct amdgpu_device {
72         atomic_t refcount;
73         int fd;
74         int flink_fd;
75         unsigned major_version;
76         unsigned minor_version;
77
78         /** List of buffer handles. Protected by bo_table_mutex. */
79         struct util_hash_table *bo_handles;
80         /** List of buffer GEM flink names. Protected by bo_table_mutex. */
81         struct util_hash_table *bo_flink_names;
82         /** This protects all hash tables. */
83         pthread_mutex_t bo_table_mutex;
84         struct drm_amdgpu_info_device dev_info;
85         struct amdgpu_gpu_info info;
86         struct amdgpu_bo_va_mgr *vamgr;
87 };
88
89 struct amdgpu_bo {
90         atomic_t refcount;
91         struct amdgpu_device *dev;
92
93         uint64_t alloc_size;
94
95         uint32_t handle;
96         uint32_t flink_name;
97
98         pthread_mutex_t cpu_access_mutex;
99         void *cpu_ptr;
100         int cpu_map_count;
101 };
102
103 struct amdgpu_bo_list {
104         struct amdgpu_device *dev;
105
106         uint32_t handle;
107 };
108
109 struct amdgpu_context {
110         struct amdgpu_device *dev;
111         /** Mutex for accessing fences and to maintain command submissions
112             in good sequence. */
113         pthread_mutex_t sequence_mutex;
114         /* context id*/
115         uint32_t id;
116 };
117
118 /**
119  * Functions.
120  */
121
122 drm_private void amdgpu_bo_free_internal(amdgpu_bo_handle bo);
123
124 drm_private struct amdgpu_bo_va_mgr*
125 amdgpu_vamgr_get_global(struct amdgpu_device *dev);
126
127 drm_private void
128 amdgpu_vamgr_reference(struct amdgpu_bo_va_mgr **dst,
129                        struct amdgpu_bo_va_mgr *src);
130
131 drm_private uint64_t
132 amdgpu_vamgr_find_va(struct amdgpu_bo_va_mgr *mgr, uint64_t size,
133                      uint64_t alignment, uint64_t base_required);
134
135 drm_private void
136 amdgpu_vamgr_free_va(struct amdgpu_bo_va_mgr *mgr, uint64_t va, uint64_t size);
137
138 drm_private int amdgpu_query_gpu_info_init(amdgpu_device_handle dev);
139
140 drm_private uint64_t amdgpu_cs_calculate_timeout(uint64_t timeout);
141
142 /**
143  * Inline functions.
144  */
145
146 /**
147  * Increment src and decrement dst as if we were updating references
148  * for an assignment between 2 pointers of some objects.
149  *
150  * \return  true if dst is 0
151  */
152 static inline bool update_references(atomic_t *dst, atomic_t *src)
153 {
154         if (dst != src) {
155                 /* bump src first */
156                 if (src) {
157                         assert(atomic_read(src) > 0);
158                         atomic_inc(src);
159                 }
160                 if (dst) {
161                         assert(atomic_read(dst) > 0);
162                         return atomic_dec_and_test(dst);
163                 }
164         }
165         return false;
166 }
167
168 /**
169  * Assignment between two amdgpu_bo pointers with reference counting.
170  *
171  * Usage:
172  *    struct amdgpu_bo *dst = ... , *src = ...;
173  *
174  *    dst = src;
175  *    // No reference counting. Only use this when you need to move
176  *    // a reference from one pointer to another.
177  *
178  *    amdgpu_bo_reference(&dst, src);
179  *    // Reference counters are updated. dst is decremented and src is
180  *    // incremented. dst is freed if its reference counter is 0.
181  */
182 static inline void amdgpu_bo_reference(struct amdgpu_bo **dst,
183                                         struct amdgpu_bo *src)
184 {
185         if (update_references(&(*dst)->refcount, &src->refcount))
186                 amdgpu_bo_free_internal(*dst);
187         *dst = src;
188 }
189
190 #endif