1 /* 2 * Copyright © 2016 Intel Corporation 3 * 4 * Permission is hereby granted, free of charge, to any person obtaining a 5 * copy of this software and associated documentation files (the "Software"), 6 * to deal in the Software without restriction, including without limitation 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 8 * and/or sell copies of the Software, and to permit persons to whom the 9 * Software is furnished to do so, subject to the following conditions: 10 * 11 * The above copyright notice and this permission notice (including the next 12 * paragraph) shall be included in all copies or substantial portions of the 13 * 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 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS 21 * IN THE SOFTWARE. 22 * 23 */ 24 25 #ifndef __I915_VMA_H__ 26 #define __I915_VMA_H__ 27 28 #include <linux/io-mapping.h> 29 #include <linux/rbtree.h> 30 31 #include <drm/drm_mm.h> 32 33 #include "gt/intel_ggtt_fencing.h" 34 #include "gem/i915_gem_object.h" 35 36 #include "i915_gem_gtt.h" 37 38 #include "i915_active.h" 39 #include "i915_request.h" 40 #include "i915_vma_types.h" 41 42 struct i915_vma * 43 i915_vma_instance(struct drm_i915_gem_object *obj, 44 struct i915_address_space *vm, 45 const struct i915_ggtt_view *view); 46 47 void i915_vma_unpin_and_release(struct i915_vma **p_vma, unsigned int flags); 48 #define I915_VMA_RELEASE_MAP BIT(0) 49 50 static inline bool i915_vma_is_active(const struct i915_vma *vma) 51 { 52 return !i915_active_is_idle(&vma->active); 53 } 54 55 int __must_check __i915_vma_move_to_active(struct i915_vma *vma, 56 struct i915_request *rq); 57 int __must_check i915_vma_move_to_active(struct i915_vma *vma, 58 struct i915_request *rq, 59 unsigned int flags); 60 61 #define __i915_vma_flags(v) ((unsigned long *)&(v)->flags.counter) 62 63 static inline bool i915_vma_is_ggtt(const struct i915_vma *vma) 64 { 65 return test_bit(I915_VMA_GGTT_BIT, __i915_vma_flags(vma)); 66 } 67 68 static inline bool i915_vma_has_ggtt_write(const struct i915_vma *vma) 69 { 70 return test_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma)); 71 } 72 73 static inline void i915_vma_set_ggtt_write(struct i915_vma *vma) 74 { 75 GEM_BUG_ON(!i915_vma_is_ggtt(vma)); 76 set_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma)); 77 } 78 79 static inline bool i915_vma_unset_ggtt_write(struct i915_vma *vma) 80 { 81 return test_and_clear_bit(I915_VMA_GGTT_WRITE_BIT, 82 __i915_vma_flags(vma)); 83 } 84 85 void i915_vma_flush_writes(struct i915_vma *vma); 86 87 static inline bool i915_vma_is_map_and_fenceable(const struct i915_vma *vma) 88 { 89 return test_bit(I915_VMA_CAN_FENCE_BIT, __i915_vma_flags(vma)); 90 } 91 92 static inline bool i915_vma_set_userfault(struct i915_vma *vma) 93 { 94 GEM_BUG_ON(!i915_vma_is_map_and_fenceable(vma)); 95 return test_and_set_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma)); 96 } 97 98 static inline void i915_vma_unset_userfault(struct i915_vma *vma) 99 { 100 return clear_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma)); 101 } 102 103 static inline bool i915_vma_has_userfault(const struct i915_vma *vma) 104 { 105 return test_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma)); 106 } 107 108 static inline bool i915_vma_is_closed(const struct i915_vma *vma) 109 { 110 return !list_empty(&vma->closed_link); 111 } 112 113 static inline u32 i915_ggtt_offset(const struct i915_vma *vma) 114 { 115 GEM_BUG_ON(!i915_vma_is_ggtt(vma)); 116 GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); 117 GEM_BUG_ON(upper_32_bits(vma->node.start)); 118 GEM_BUG_ON(upper_32_bits(vma->node.start + vma->node.size - 1)); 119 return lower_32_bits(vma->node.start); 120 } 121 122 static inline u32 i915_ggtt_pin_bias(struct i915_vma *vma) 123 { 124 return i915_vm_to_ggtt(vma->vm)->pin_bias; 125 } 126 127 static inline struct i915_vma *i915_vma_get(struct i915_vma *vma) 128 { 129 i915_gem_object_get(vma->obj); 130 return vma; 131 } 132 133 static inline struct i915_vma *i915_vma_tryget(struct i915_vma *vma) 134 { 135 if (likely(kref_get_unless_zero(&vma->obj->base.refcount))) 136 return vma; 137 138 return NULL; 139 } 140 141 static inline void i915_vma_put(struct i915_vma *vma) 142 { 143 i915_gem_object_put(vma->obj); 144 } 145 146 static __always_inline ptrdiff_t ptrdiff(const void *a, const void *b) 147 { 148 return a - b; 149 } 150 151 static inline long 152 i915_vma_compare(struct i915_vma *vma, 153 struct i915_address_space *vm, 154 const struct i915_ggtt_view *view) 155 { 156 ptrdiff_t cmp; 157 158 GEM_BUG_ON(view && !i915_is_ggtt(vm)); 159 160 cmp = ptrdiff(vma->vm, vm); 161 if (cmp) 162 return cmp; 163 164 BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL != 0); 165 cmp = vma->ggtt_view.type; 166 if (!view) 167 return cmp; 168 169 cmp -= view->type; 170 if (cmp) 171 return cmp; 172 173 assert_i915_gem_gtt_types(); 174 175 /* ggtt_view.type also encodes its size so that we both distinguish 176 * different views using it as a "type" and also use a compact (no 177 * accessing of uninitialised padding bytes) memcmp without storing 178 * an extra parameter or adding more code. 179 * 180 * To ensure that the memcmp is valid for all branches of the union, 181 * even though the code looks like it is just comparing one branch, 182 * we assert above that all branches have the same address, and that 183 * each branch has a unique type/size. 184 */ 185 BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL >= I915_GGTT_VIEW_PARTIAL); 186 BUILD_BUG_ON(I915_GGTT_VIEW_PARTIAL >= I915_GGTT_VIEW_ROTATED); 187 BUILD_BUG_ON(I915_GGTT_VIEW_ROTATED >= I915_GGTT_VIEW_REMAPPED); 188 BUILD_BUG_ON(offsetof(typeof(*view), rotated) != 189 offsetof(typeof(*view), partial)); 190 BUILD_BUG_ON(offsetof(typeof(*view), rotated) != 191 offsetof(typeof(*view), remapped)); 192 return memcmp(&vma->ggtt_view.partial, &view->partial, view->type); 193 } 194 195 struct i915_vma_work *i915_vma_work(void); 196 int i915_vma_bind(struct i915_vma *vma, 197 enum i915_cache_level cache_level, 198 u32 flags, 199 struct i915_vma_work *work); 200 201 bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long color); 202 bool i915_vma_misplaced(const struct i915_vma *vma, 203 u64 size, u64 alignment, u64 flags); 204 void __i915_vma_set_map_and_fenceable(struct i915_vma *vma); 205 void i915_vma_revoke_mmap(struct i915_vma *vma); 206 void __i915_vma_evict(struct i915_vma *vma); 207 int __i915_vma_unbind(struct i915_vma *vma); 208 int __must_check i915_vma_unbind(struct i915_vma *vma); 209 void i915_vma_unlink_ctx(struct i915_vma *vma); 210 void i915_vma_close(struct i915_vma *vma); 211 void i915_vma_reopen(struct i915_vma *vma); 212 213 static inline struct i915_vma *__i915_vma_get(struct i915_vma *vma) 214 { 215 if (kref_get_unless_zero(&vma->ref)) 216 return vma; 217 218 return NULL; 219 } 220 221 void i915_vma_release(struct kref *ref); 222 static inline void __i915_vma_put(struct i915_vma *vma) 223 { 224 kref_put(&vma->ref, i915_vma_release); 225 } 226 227 #define assert_vma_held(vma) dma_resv_assert_held((vma)->resv) 228 229 static inline void i915_vma_lock(struct i915_vma *vma) 230 { 231 dma_resv_lock(vma->resv, NULL); 232 } 233 234 static inline void i915_vma_unlock(struct i915_vma *vma) 235 { 236 dma_resv_unlock(vma->resv); 237 } 238 239 int __must_check 240 i915_vma_pin_ww(struct i915_vma *vma, struct i915_gem_ww_ctx *ww, 241 u64 size, u64 alignment, u64 flags); 242 243 static inline int __must_check 244 i915_vma_pin(struct i915_vma *vma, u64 size, u64 alignment, u64 flags) 245 { 246 return i915_vma_pin_ww(vma, NULL, size, alignment, flags); 247 } 248 249 int i915_ggtt_pin(struct i915_vma *vma, struct i915_gem_ww_ctx *ww, 250 u32 align, unsigned int flags); 251 252 static inline int i915_vma_pin_count(const struct i915_vma *vma) 253 { 254 return atomic_read(&vma->flags) & I915_VMA_PIN_MASK; 255 } 256 257 static inline bool i915_vma_is_pinned(const struct i915_vma *vma) 258 { 259 return i915_vma_pin_count(vma); 260 } 261 262 static inline void __i915_vma_pin(struct i915_vma *vma) 263 { 264 atomic_inc(&vma->flags); 265 GEM_BUG_ON(!i915_vma_is_pinned(vma)); 266 } 267 268 static inline void __i915_vma_unpin(struct i915_vma *vma) 269 { 270 GEM_BUG_ON(!i915_vma_is_pinned(vma)); 271 atomic_dec(&vma->flags); 272 } 273 274 static inline void i915_vma_unpin(struct i915_vma *vma) 275 { 276 GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); 277 __i915_vma_unpin(vma); 278 } 279 280 static inline bool i915_vma_is_bound(const struct i915_vma *vma, 281 unsigned int where) 282 { 283 return atomic_read(&vma->flags) & where; 284 } 285 286 static inline bool i915_node_color_differs(const struct drm_mm_node *node, 287 unsigned long color) 288 { 289 return drm_mm_node_allocated(node) && node->color != color; 290 } 291 292 /** 293 * i915_vma_pin_iomap - calls ioremap_wc to map the GGTT VMA via the aperture 294 * @vma: VMA to iomap 295 * 296 * The passed in VMA has to be pinned in the global GTT mappable region. 297 * An extra pinning of the VMA is acquired for the return iomapping, 298 * the caller must call i915_vma_unpin_iomap to relinquish the pinning 299 * after the iomapping is no longer required. 300 * 301 * Returns a valid iomapped pointer or ERR_PTR. 302 */ 303 void __iomem *i915_vma_pin_iomap(struct i915_vma *vma); 304 #define IO_ERR_PTR(x) ((void __iomem *)ERR_PTR(x)) 305 306 /** 307 * i915_vma_unpin_iomap - unpins the mapping returned from i915_vma_iomap 308 * @vma: VMA to unpin 309 * 310 * Unpins the previously iomapped VMA from i915_vma_pin_iomap(). 311 * 312 * This function is only valid to be called on a VMA previously 313 * iomapped by the caller with i915_vma_pin_iomap(). 314 */ 315 void i915_vma_unpin_iomap(struct i915_vma *vma); 316 317 static inline struct page *i915_vma_first_page(struct i915_vma *vma) 318 { 319 GEM_BUG_ON(!vma->pages); 320 return sg_page(vma->pages->sgl); 321 } 322 323 /** 324 * i915_vma_pin_fence - pin fencing state 325 * @vma: vma to pin fencing for 326 * 327 * This pins the fencing state (whether tiled or untiled) to make sure the 328 * vma (and its object) is ready to be used as a scanout target. Fencing 329 * status must be synchronize first by calling i915_vma_get_fence(): 330 * 331 * The resulting fence pin reference must be released again with 332 * i915_vma_unpin_fence(). 333 * 334 * Returns: 335 * 336 * True if the vma has a fence, false otherwise. 337 */ 338 int __must_check i915_vma_pin_fence(struct i915_vma *vma); 339 void i915_vma_revoke_fence(struct i915_vma *vma); 340 341 int __i915_vma_pin_fence(struct i915_vma *vma); 342 343 static inline void __i915_vma_unpin_fence(struct i915_vma *vma) 344 { 345 GEM_BUG_ON(atomic_read(&vma->fence->pin_count) <= 0); 346 atomic_dec(&vma->fence->pin_count); 347 } 348 349 /** 350 * i915_vma_unpin_fence - unpin fencing state 351 * @vma: vma to unpin fencing for 352 * 353 * This releases the fence pin reference acquired through 354 * i915_vma_pin_fence. It will handle both objects with and without an 355 * attached fence correctly, callers do not need to distinguish this. 356 */ 357 static inline void 358 i915_vma_unpin_fence(struct i915_vma *vma) 359 { 360 if (vma->fence) 361 __i915_vma_unpin_fence(vma); 362 } 363 364 void i915_vma_parked(struct intel_gt *gt); 365 366 #define for_each_until(cond) if (cond) break; else 367 368 /** 369 * for_each_ggtt_vma - Iterate over the GGTT VMA belonging to an object. 370 * @V: the #i915_vma iterator 371 * @OBJ: the #drm_i915_gem_object 372 * 373 * GGTT VMA are placed at the being of the object's vma_list, see 374 * vma_create(), so we can stop our walk as soon as we see a ppgtt VMA, 375 * or the list is empty ofc. 376 */ 377 #define for_each_ggtt_vma(V, OBJ) \ 378 list_for_each_entry(V, &(OBJ)->vma.list, obj_link) \ 379 for_each_until(!i915_vma_is_ggtt(V)) 380 381 struct i915_vma *i915_vma_alloc(void); 382 void i915_vma_free(struct i915_vma *vma); 383 384 struct i915_vma *i915_vma_make_unshrinkable(struct i915_vma *vma); 385 void i915_vma_make_shrinkable(struct i915_vma *vma); 386 void i915_vma_make_purgeable(struct i915_vma *vma); 387 388 int i915_vma_wait_for_bind(struct i915_vma *vma); 389 390 static inline int i915_vma_sync(struct i915_vma *vma) 391 { 392 /* Wait for the asynchronous bindings and pending GPU reads */ 393 return i915_active_wait(&vma->active); 394 } 395 396 #endif 397