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 /* do not reserve memory to prevent deadlocks */ 56 #define __EXEC_OBJECT_NO_RESERVE BIT(31) 57 58 int __must_check __i915_vma_move_to_active(struct i915_vma *vma, 59 struct i915_request *rq); 60 int __must_check _i915_vma_move_to_active(struct i915_vma *vma, 61 struct i915_request *rq, 62 struct dma_fence *fence, 63 unsigned int flags); 64 static inline int __must_check 65 i915_vma_move_to_active(struct i915_vma *vma, struct i915_request *rq, 66 unsigned int flags) 67 { 68 return _i915_vma_move_to_active(vma, rq, &rq->fence, flags); 69 } 70 71 #define __i915_vma_flags(v) ((unsigned long *)&(v)->flags.counter) 72 73 static inline bool i915_vma_is_ggtt(const struct i915_vma *vma) 74 { 75 return test_bit(I915_VMA_GGTT_BIT, __i915_vma_flags(vma)); 76 } 77 78 static inline bool i915_vma_is_dpt(const struct i915_vma *vma) 79 { 80 return i915_is_dpt(vma->vm); 81 } 82 83 static inline bool i915_vma_has_ggtt_write(const struct i915_vma *vma) 84 { 85 return test_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma)); 86 } 87 88 static inline void i915_vma_set_ggtt_write(struct i915_vma *vma) 89 { 90 GEM_BUG_ON(!i915_vma_is_ggtt(vma)); 91 set_bit(I915_VMA_GGTT_WRITE_BIT, __i915_vma_flags(vma)); 92 } 93 94 static inline bool i915_vma_unset_ggtt_write(struct i915_vma *vma) 95 { 96 return test_and_clear_bit(I915_VMA_GGTT_WRITE_BIT, 97 __i915_vma_flags(vma)); 98 } 99 100 void i915_vma_flush_writes(struct i915_vma *vma); 101 102 static inline bool i915_vma_is_map_and_fenceable(const struct i915_vma *vma) 103 { 104 return test_bit(I915_VMA_CAN_FENCE_BIT, __i915_vma_flags(vma)); 105 } 106 107 static inline bool i915_vma_set_userfault(struct i915_vma *vma) 108 { 109 GEM_BUG_ON(!i915_vma_is_map_and_fenceable(vma)); 110 return test_and_set_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma)); 111 } 112 113 static inline void i915_vma_unset_userfault(struct i915_vma *vma) 114 { 115 return clear_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma)); 116 } 117 118 static inline bool i915_vma_has_userfault(const struct i915_vma *vma) 119 { 120 return test_bit(I915_VMA_USERFAULT_BIT, __i915_vma_flags(vma)); 121 } 122 123 static inline bool i915_vma_is_closed(const struct i915_vma *vma) 124 { 125 return !list_empty(&vma->closed_link); 126 } 127 128 static inline u32 i915_ggtt_offset(const struct i915_vma *vma) 129 { 130 GEM_BUG_ON(!i915_vma_is_ggtt(vma)); 131 GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); 132 GEM_BUG_ON(upper_32_bits(vma->node.start)); 133 GEM_BUG_ON(upper_32_bits(vma->node.start + vma->node.size - 1)); 134 return lower_32_bits(vma->node.start); 135 } 136 137 static inline u32 i915_ggtt_pin_bias(struct i915_vma *vma) 138 { 139 return i915_vm_to_ggtt(vma->vm)->pin_bias; 140 } 141 142 static inline struct i915_vma *i915_vma_get(struct i915_vma *vma) 143 { 144 i915_gem_object_get(vma->obj); 145 return vma; 146 } 147 148 static inline struct i915_vma *i915_vma_tryget(struct i915_vma *vma) 149 { 150 if (likely(kref_get_unless_zero(&vma->obj->base.refcount))) 151 return vma; 152 153 return NULL; 154 } 155 156 static inline void i915_vma_put(struct i915_vma *vma) 157 { 158 i915_gem_object_put(vma->obj); 159 } 160 161 static inline long 162 i915_vma_compare(struct i915_vma *vma, 163 struct i915_address_space *vm, 164 const struct i915_ggtt_view *view) 165 { 166 ptrdiff_t cmp; 167 168 GEM_BUG_ON(view && !i915_is_ggtt_or_dpt(vm)); 169 170 cmp = ptrdiff(vma->vm, vm); 171 if (cmp) 172 return cmp; 173 174 BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL != 0); 175 cmp = vma->ggtt_view.type; 176 if (!view) 177 return cmp; 178 179 cmp -= view->type; 180 if (cmp) 181 return cmp; 182 183 assert_i915_gem_gtt_types(); 184 185 /* ggtt_view.type also encodes its size so that we both distinguish 186 * different views using it as a "type" and also use a compact (no 187 * accessing of uninitialised padding bytes) memcmp without storing 188 * an extra parameter or adding more code. 189 * 190 * To ensure that the memcmp is valid for all branches of the union, 191 * even though the code looks like it is just comparing one branch, 192 * we assert above that all branches have the same address, and that 193 * each branch has a unique type/size. 194 */ 195 BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL >= I915_GGTT_VIEW_PARTIAL); 196 BUILD_BUG_ON(I915_GGTT_VIEW_PARTIAL >= I915_GGTT_VIEW_ROTATED); 197 BUILD_BUG_ON(I915_GGTT_VIEW_ROTATED >= I915_GGTT_VIEW_REMAPPED); 198 BUILD_BUG_ON(offsetof(typeof(*view), rotated) != 199 offsetof(typeof(*view), partial)); 200 BUILD_BUG_ON(offsetof(typeof(*view), rotated) != 201 offsetof(typeof(*view), remapped)); 202 return memcmp(&vma->ggtt_view.partial, &view->partial, view->type); 203 } 204 205 struct i915_vma_work *i915_vma_work(void); 206 int i915_vma_bind(struct i915_vma *vma, 207 enum i915_cache_level cache_level, 208 u32 flags, 209 struct i915_vma_work *work); 210 211 bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long color); 212 bool i915_vma_misplaced(const struct i915_vma *vma, 213 u64 size, u64 alignment, u64 flags); 214 void __i915_vma_set_map_and_fenceable(struct i915_vma *vma); 215 void i915_vma_revoke_mmap(struct i915_vma *vma); 216 void __i915_vma_evict(struct i915_vma *vma); 217 int __i915_vma_unbind(struct i915_vma *vma); 218 int __must_check i915_vma_unbind(struct i915_vma *vma); 219 void i915_vma_unlink_ctx(struct i915_vma *vma); 220 void i915_vma_close(struct i915_vma *vma); 221 void i915_vma_reopen(struct i915_vma *vma); 222 223 static inline struct i915_vma *__i915_vma_get(struct i915_vma *vma) 224 { 225 if (kref_get_unless_zero(&vma->ref)) 226 return vma; 227 228 return NULL; 229 } 230 231 void i915_vma_release(struct kref *ref); 232 static inline void __i915_vma_put(struct i915_vma *vma) 233 { 234 kref_put(&vma->ref, i915_vma_release); 235 } 236 237 #define assert_vma_held(vma) dma_resv_assert_held((vma)->resv) 238 239 static inline void i915_vma_lock(struct i915_vma *vma) 240 { 241 dma_resv_lock(vma->resv, NULL); 242 } 243 244 static inline void i915_vma_unlock(struct i915_vma *vma) 245 { 246 dma_resv_unlock(vma->resv); 247 } 248 249 int __must_check 250 i915_vma_pin_ww(struct i915_vma *vma, struct i915_gem_ww_ctx *ww, 251 u64 size, u64 alignment, u64 flags); 252 253 static inline int __must_check 254 i915_vma_pin(struct i915_vma *vma, u64 size, u64 alignment, u64 flags) 255 { 256 struct i915_gem_ww_ctx ww; 257 int err; 258 259 i915_gem_ww_ctx_init(&ww, true); 260 retry: 261 err = i915_gem_object_lock(vma->obj, &ww); 262 if (!err) 263 err = i915_vma_pin_ww(vma, &ww, size, alignment, flags); 264 if (err == -EDEADLK) { 265 err = i915_gem_ww_ctx_backoff(&ww); 266 if (!err) 267 goto retry; 268 } 269 i915_gem_ww_ctx_fini(&ww); 270 271 return err; 272 } 273 274 int i915_ggtt_pin(struct i915_vma *vma, struct i915_gem_ww_ctx *ww, 275 u32 align, unsigned int flags); 276 277 static inline int i915_vma_pin_count(const struct i915_vma *vma) 278 { 279 return atomic_read(&vma->flags) & I915_VMA_PIN_MASK; 280 } 281 282 static inline bool i915_vma_is_pinned(const struct i915_vma *vma) 283 { 284 return i915_vma_pin_count(vma); 285 } 286 287 static inline void __i915_vma_pin(struct i915_vma *vma) 288 { 289 atomic_inc(&vma->flags); 290 GEM_BUG_ON(!i915_vma_is_pinned(vma)); 291 } 292 293 static inline void __i915_vma_unpin(struct i915_vma *vma) 294 { 295 GEM_BUG_ON(!i915_vma_is_pinned(vma)); 296 atomic_dec(&vma->flags); 297 } 298 299 static inline void i915_vma_unpin(struct i915_vma *vma) 300 { 301 GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); 302 __i915_vma_unpin(vma); 303 } 304 305 static inline bool i915_vma_is_bound(const struct i915_vma *vma, 306 unsigned int where) 307 { 308 return atomic_read(&vma->flags) & where; 309 } 310 311 static inline bool i915_node_color_differs(const struct drm_mm_node *node, 312 unsigned long color) 313 { 314 return drm_mm_node_allocated(node) && node->color != color; 315 } 316 317 /** 318 * i915_vma_pin_iomap - calls ioremap_wc to map the GGTT VMA via the aperture 319 * @vma: VMA to iomap 320 * 321 * The passed in VMA has to be pinned in the global GTT mappable region. 322 * An extra pinning of the VMA is acquired for the return iomapping, 323 * the caller must call i915_vma_unpin_iomap to relinquish the pinning 324 * after the iomapping is no longer required. 325 * 326 * Returns a valid iomapped pointer or ERR_PTR. 327 */ 328 void __iomem *i915_vma_pin_iomap(struct i915_vma *vma); 329 #define IO_ERR_PTR(x) ((void __iomem *)ERR_PTR(x)) 330 331 /** 332 * i915_vma_unpin_iomap - unpins the mapping returned from i915_vma_iomap 333 * @vma: VMA to unpin 334 * 335 * Unpins the previously iomapped VMA from i915_vma_pin_iomap(). 336 * 337 * This function is only valid to be called on a VMA previously 338 * iomapped by the caller with i915_vma_pin_iomap(). 339 */ 340 void i915_vma_unpin_iomap(struct i915_vma *vma); 341 342 static inline struct page *i915_vma_first_page(struct i915_vma *vma) 343 { 344 GEM_BUG_ON(!vma->pages); 345 return sg_page(vma->pages->sgl); 346 } 347 348 /** 349 * i915_vma_pin_fence - pin fencing state 350 * @vma: vma to pin fencing for 351 * 352 * This pins the fencing state (whether tiled or untiled) to make sure the 353 * vma (and its object) is ready to be used as a scanout target. Fencing 354 * status must be synchronize first by calling i915_vma_get_fence(): 355 * 356 * The resulting fence pin reference must be released again with 357 * i915_vma_unpin_fence(). 358 * 359 * Returns: 360 * 361 * True if the vma has a fence, false otherwise. 362 */ 363 int __must_check i915_vma_pin_fence(struct i915_vma *vma); 364 void i915_vma_revoke_fence(struct i915_vma *vma); 365 366 int __i915_vma_pin_fence(struct i915_vma *vma); 367 368 static inline void __i915_vma_unpin_fence(struct i915_vma *vma) 369 { 370 GEM_BUG_ON(atomic_read(&vma->fence->pin_count) <= 0); 371 atomic_dec(&vma->fence->pin_count); 372 } 373 374 /** 375 * i915_vma_unpin_fence - unpin fencing state 376 * @vma: vma to unpin fencing for 377 * 378 * This releases the fence pin reference acquired through 379 * i915_vma_pin_fence. It will handle both objects with and without an 380 * attached fence correctly, callers do not need to distinguish this. 381 */ 382 static inline void 383 i915_vma_unpin_fence(struct i915_vma *vma) 384 { 385 if (vma->fence) 386 __i915_vma_unpin_fence(vma); 387 } 388 389 void i915_vma_parked(struct intel_gt *gt); 390 391 static inline bool i915_vma_is_scanout(const struct i915_vma *vma) 392 { 393 return test_bit(I915_VMA_SCANOUT_BIT, __i915_vma_flags(vma)); 394 } 395 396 static inline void i915_vma_mark_scanout(struct i915_vma *vma) 397 { 398 set_bit(I915_VMA_SCANOUT_BIT, __i915_vma_flags(vma)); 399 } 400 401 static inline void i915_vma_clear_scanout(struct i915_vma *vma) 402 { 403 clear_bit(I915_VMA_SCANOUT_BIT, __i915_vma_flags(vma)); 404 } 405 406 #define for_each_until(cond) if (cond) break; else 407 408 /** 409 * for_each_ggtt_vma - Iterate over the GGTT VMA belonging to an object. 410 * @V: the #i915_vma iterator 411 * @OBJ: the #drm_i915_gem_object 412 * 413 * GGTT VMA are placed at the being of the object's vma_list, see 414 * vma_create(), so we can stop our walk as soon as we see a ppgtt VMA, 415 * or the list is empty ofc. 416 */ 417 #define for_each_ggtt_vma(V, OBJ) \ 418 list_for_each_entry(V, &(OBJ)->vma.list, obj_link) \ 419 for_each_until(!i915_vma_is_ggtt(V)) 420 421 struct i915_vma *i915_vma_alloc(void); 422 void i915_vma_free(struct i915_vma *vma); 423 424 struct i915_vma *i915_vma_make_unshrinkable(struct i915_vma *vma); 425 void i915_vma_make_shrinkable(struct i915_vma *vma); 426 void i915_vma_make_purgeable(struct i915_vma *vma); 427 428 int i915_vma_wait_for_bind(struct i915_vma *vma); 429 430 static inline int i915_vma_sync(struct i915_vma *vma) 431 { 432 /* Wait for the asynchronous bindings and pending GPU reads */ 433 return i915_active_wait(&vma->active); 434 } 435 436 void i915_vma_module_exit(void); 437 int i915_vma_module_init(void); 438 439 #endif 440