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