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