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 30 #include <drm/drm_mm.h> 31 32 #include "i915_gem_gtt.h" 33 #include "i915_gem_fence_reg.h" 34 #include "i915_gem_object.h" 35 36 #include "i915_request.h" 37 38 enum i915_cache_level; 39 40 /** 41 * A VMA represents a GEM BO that is bound into an address space. Therefore, a 42 * VMA's presence cannot be guaranteed before binding, or after unbinding the 43 * object into/from the address space. 44 * 45 * To make things as simple as possible (ie. no refcounting), a VMA's lifetime 46 * will always be <= an objects lifetime. So object refcounting should cover us. 47 */ 48 struct i915_vma { 49 struct drm_mm_node node; 50 struct drm_i915_gem_object *obj; 51 struct i915_address_space *vm; 52 struct drm_i915_fence_reg *fence; 53 struct reservation_object *resv; /** Alias of obj->resv */ 54 struct sg_table *pages; 55 void __iomem *iomap; 56 u64 size; 57 u64 display_alignment; 58 struct i915_page_sizes page_sizes; 59 60 u32 fence_size; 61 u32 fence_alignment; 62 63 /** 64 * Count of the number of times this vma has been opened by different 65 * handles (but same file) for execbuf, i.e. the number of aliases 66 * that exist in the ctx->handle_vmas LUT for this vma. 67 */ 68 unsigned int open_count; 69 unsigned long flags; 70 /** 71 * How many users have pinned this object in GTT space. The following 72 * users can each hold at most one reference: pwrite/pread, execbuffer 73 * (objects are not allowed multiple times for the same batchbuffer), 74 * and the framebuffer code. When switching/pageflipping, the 75 * framebuffer code has at most two buffers pinned per crtc. 76 * 77 * In the worst case this is 1 + 1 + 1 + 2*2 = 7. That would fit into 3 78 * bits with absolutely no headroom. So use 4 bits. 79 */ 80 #define I915_VMA_PIN_MASK 0xf 81 #define I915_VMA_PIN_OVERFLOW BIT(5) 82 83 /** Flags and address space this VMA is bound to */ 84 #define I915_VMA_GLOBAL_BIND BIT(6) 85 #define I915_VMA_LOCAL_BIND BIT(7) 86 #define I915_VMA_BIND_MASK (I915_VMA_GLOBAL_BIND | I915_VMA_LOCAL_BIND | I915_VMA_PIN_OVERFLOW) 87 88 #define I915_VMA_GGTT BIT(8) 89 #define I915_VMA_CAN_FENCE BIT(9) 90 #define I915_VMA_CLOSED BIT(10) 91 #define I915_VMA_USERFAULT_BIT 11 92 #define I915_VMA_USERFAULT BIT(I915_VMA_USERFAULT_BIT) 93 #define I915_VMA_GGTT_WRITE BIT(12) 94 95 unsigned int active; 96 struct i915_gem_active last_read[I915_NUM_ENGINES]; 97 struct i915_gem_active last_fence; 98 99 /** 100 * Support different GGTT views into the same object. 101 * This means there can be multiple VMA mappings per object and per VM. 102 * i915_ggtt_view_type is used to distinguish between those entries. 103 * The default one of zero (I915_GGTT_VIEW_NORMAL) is default and also 104 * assumed in GEM functions which take no ggtt view parameter. 105 */ 106 struct i915_ggtt_view ggtt_view; 107 108 /** This object's place on the active/inactive lists */ 109 struct list_head vm_link; 110 111 struct list_head obj_link; /* Link in the object's VMA list */ 112 struct rb_node obj_node; 113 struct hlist_node obj_hash; 114 115 /** This vma's place in the execbuf reservation list */ 116 struct list_head exec_link; 117 struct list_head reloc_link; 118 119 /** This vma's place in the eviction list */ 120 struct list_head evict_link; 121 122 struct list_head closed_link; 123 124 /** 125 * Used for performing relocations during execbuffer insertion. 126 */ 127 unsigned int *exec_flags; 128 struct hlist_node exec_node; 129 u32 exec_handle; 130 }; 131 132 struct i915_vma * 133 i915_vma_instance(struct drm_i915_gem_object *obj, 134 struct i915_address_space *vm, 135 const struct i915_ggtt_view *view); 136 137 void i915_vma_unpin_and_release(struct i915_vma **p_vma); 138 139 static inline bool i915_vma_is_ggtt(const struct i915_vma *vma) 140 { 141 return vma->flags & I915_VMA_GGTT; 142 } 143 144 static inline bool i915_vma_has_ggtt_write(const struct i915_vma *vma) 145 { 146 return vma->flags & I915_VMA_GGTT_WRITE; 147 } 148 149 static inline void i915_vma_set_ggtt_write(struct i915_vma *vma) 150 { 151 GEM_BUG_ON(!i915_vma_is_ggtt(vma)); 152 vma->flags |= I915_VMA_GGTT_WRITE; 153 } 154 155 static inline void i915_vma_unset_ggtt_write(struct i915_vma *vma) 156 { 157 vma->flags &= ~I915_VMA_GGTT_WRITE; 158 } 159 160 void i915_vma_flush_writes(struct i915_vma *vma); 161 162 static inline bool i915_vma_is_map_and_fenceable(const struct i915_vma *vma) 163 { 164 return vma->flags & I915_VMA_CAN_FENCE; 165 } 166 167 static inline bool i915_vma_is_closed(const struct i915_vma *vma) 168 { 169 return vma->flags & I915_VMA_CLOSED; 170 } 171 172 static inline bool i915_vma_set_userfault(struct i915_vma *vma) 173 { 174 GEM_BUG_ON(!i915_vma_is_map_and_fenceable(vma)); 175 return __test_and_set_bit(I915_VMA_USERFAULT_BIT, &vma->flags); 176 } 177 178 static inline void i915_vma_unset_userfault(struct i915_vma *vma) 179 { 180 return __clear_bit(I915_VMA_USERFAULT_BIT, &vma->flags); 181 } 182 183 static inline bool i915_vma_has_userfault(const struct i915_vma *vma) 184 { 185 return test_bit(I915_VMA_USERFAULT_BIT, &vma->flags); 186 } 187 188 static inline unsigned int i915_vma_get_active(const struct i915_vma *vma) 189 { 190 return vma->active; 191 } 192 193 static inline bool i915_vma_is_active(const struct i915_vma *vma) 194 { 195 return i915_vma_get_active(vma); 196 } 197 198 static inline void i915_vma_set_active(struct i915_vma *vma, 199 unsigned int engine) 200 { 201 vma->active |= BIT(engine); 202 } 203 204 static inline void i915_vma_clear_active(struct i915_vma *vma, 205 unsigned int engine) 206 { 207 vma->active &= ~BIT(engine); 208 } 209 210 static inline bool i915_vma_has_active_engine(const struct i915_vma *vma, 211 unsigned int engine) 212 { 213 return vma->active & BIT(engine); 214 } 215 216 static inline u32 i915_ggtt_offset(const struct i915_vma *vma) 217 { 218 GEM_BUG_ON(!i915_vma_is_ggtt(vma)); 219 GEM_BUG_ON(!vma->node.allocated); 220 GEM_BUG_ON(upper_32_bits(vma->node.start)); 221 GEM_BUG_ON(upper_32_bits(vma->node.start + vma->node.size - 1)); 222 return lower_32_bits(vma->node.start); 223 } 224 225 static inline struct i915_vma *i915_vma_get(struct i915_vma *vma) 226 { 227 i915_gem_object_get(vma->obj); 228 return vma; 229 } 230 231 static inline void i915_vma_put(struct i915_vma *vma) 232 { 233 i915_gem_object_put(vma->obj); 234 } 235 236 static __always_inline ptrdiff_t ptrdiff(const void *a, const void *b) 237 { 238 return a - b; 239 } 240 241 static inline long 242 i915_vma_compare(struct i915_vma *vma, 243 struct i915_address_space *vm, 244 const struct i915_ggtt_view *view) 245 { 246 ptrdiff_t cmp; 247 248 GEM_BUG_ON(view && !i915_is_ggtt(vm)); 249 250 cmp = ptrdiff(vma->vm, vm); 251 if (cmp) 252 return cmp; 253 254 BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL != 0); 255 cmp = vma->ggtt_view.type; 256 if (!view) 257 return cmp; 258 259 cmp -= view->type; 260 if (cmp) 261 return cmp; 262 263 /* ggtt_view.type also encodes its size so that we both distinguish 264 * different views using it as a "type" and also use a compact (no 265 * accessing of uninitialised padding bytes) memcmp without storing 266 * an extra parameter or adding more code. 267 * 268 * To ensure that the memcmp is valid for all branches of the union, 269 * even though the code looks like it is just comparing one branch, 270 * we assert above that all branches have the same address, and that 271 * each branch has a unique type/size. 272 */ 273 BUILD_BUG_ON(I915_GGTT_VIEW_NORMAL >= I915_GGTT_VIEW_PARTIAL); 274 BUILD_BUG_ON(I915_GGTT_VIEW_PARTIAL >= I915_GGTT_VIEW_ROTATED); 275 BUILD_BUG_ON(offsetof(typeof(*view), rotated) != 276 offsetof(typeof(*view), partial)); 277 return memcmp(&vma->ggtt_view.partial, &view->partial, view->type); 278 } 279 280 int i915_vma_bind(struct i915_vma *vma, enum i915_cache_level cache_level, 281 u32 flags); 282 bool i915_gem_valid_gtt_space(struct i915_vma *vma, unsigned long cache_level); 283 bool i915_vma_misplaced(const struct i915_vma *vma, 284 u64 size, u64 alignment, u64 flags); 285 void __i915_vma_set_map_and_fenceable(struct i915_vma *vma); 286 void i915_vma_revoke_mmap(struct i915_vma *vma); 287 int __must_check i915_vma_unbind(struct i915_vma *vma); 288 void i915_vma_unlink_ctx(struct i915_vma *vma); 289 void i915_vma_close(struct i915_vma *vma); 290 void i915_vma_reopen(struct i915_vma *vma); 291 void i915_vma_destroy(struct i915_vma *vma); 292 293 int __i915_vma_do_pin(struct i915_vma *vma, 294 u64 size, u64 alignment, u64 flags); 295 static inline int __must_check 296 i915_vma_pin(struct i915_vma *vma, u64 size, u64 alignment, u64 flags) 297 { 298 BUILD_BUG_ON(PIN_MBZ != I915_VMA_PIN_OVERFLOW); 299 BUILD_BUG_ON(PIN_GLOBAL != I915_VMA_GLOBAL_BIND); 300 BUILD_BUG_ON(PIN_USER != I915_VMA_LOCAL_BIND); 301 302 /* Pin early to prevent the shrinker/eviction logic from destroying 303 * our vma as we insert and bind. 304 */ 305 if (likely(((++vma->flags ^ flags) & I915_VMA_BIND_MASK) == 0)) { 306 GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); 307 GEM_BUG_ON(i915_vma_misplaced(vma, size, alignment, flags)); 308 return 0; 309 } 310 311 return __i915_vma_do_pin(vma, size, alignment, flags); 312 } 313 314 static inline int i915_vma_pin_count(const struct i915_vma *vma) 315 { 316 return vma->flags & I915_VMA_PIN_MASK; 317 } 318 319 static inline bool i915_vma_is_pinned(const struct i915_vma *vma) 320 { 321 return i915_vma_pin_count(vma); 322 } 323 324 static inline void __i915_vma_pin(struct i915_vma *vma) 325 { 326 vma->flags++; 327 GEM_BUG_ON(vma->flags & I915_VMA_PIN_OVERFLOW); 328 } 329 330 static inline void __i915_vma_unpin(struct i915_vma *vma) 331 { 332 vma->flags--; 333 } 334 335 static inline void i915_vma_unpin(struct i915_vma *vma) 336 { 337 GEM_BUG_ON(!i915_vma_is_pinned(vma)); 338 GEM_BUG_ON(!drm_mm_node_allocated(&vma->node)); 339 __i915_vma_unpin(vma); 340 } 341 342 /** 343 * i915_vma_pin_iomap - calls ioremap_wc to map the GGTT VMA via the aperture 344 * @vma: VMA to iomap 345 * 346 * The passed in VMA has to be pinned in the global GTT mappable region. 347 * An extra pinning of the VMA is acquired for the return iomapping, 348 * the caller must call i915_vma_unpin_iomap to relinquish the pinning 349 * after the iomapping is no longer required. 350 * 351 * Callers must hold the struct_mutex. 352 * 353 * Returns a valid iomapped pointer or ERR_PTR. 354 */ 355 void __iomem *i915_vma_pin_iomap(struct i915_vma *vma); 356 #define IO_ERR_PTR(x) ((void __iomem *)ERR_PTR(x)) 357 358 /** 359 * i915_vma_unpin_iomap - unpins the mapping returned from i915_vma_iomap 360 * @vma: VMA to unpin 361 * 362 * Unpins the previously iomapped VMA from i915_vma_pin_iomap(). 363 * 364 * Callers must hold the struct_mutex. This function is only valid to be 365 * called on a VMA previously iomapped by the caller with i915_vma_pin_iomap(). 366 */ 367 void i915_vma_unpin_iomap(struct i915_vma *vma); 368 369 static inline struct page *i915_vma_first_page(struct i915_vma *vma) 370 { 371 GEM_BUG_ON(!vma->pages); 372 return sg_page(vma->pages->sgl); 373 } 374 375 /** 376 * i915_vma_pin_fence - pin fencing state 377 * @vma: vma to pin fencing for 378 * 379 * This pins the fencing state (whether tiled or untiled) to make sure the 380 * vma (and its object) is ready to be used as a scanout target. Fencing 381 * status must be synchronize first by calling i915_vma_get_fence(): 382 * 383 * The resulting fence pin reference must be released again with 384 * i915_vma_unpin_fence(). 385 * 386 * Returns: 387 * 388 * True if the vma has a fence, false otherwise. 389 */ 390 int i915_vma_pin_fence(struct i915_vma *vma); 391 int __must_check i915_vma_put_fence(struct i915_vma *vma); 392 393 static inline void __i915_vma_unpin_fence(struct i915_vma *vma) 394 { 395 GEM_BUG_ON(vma->fence->pin_count <= 0); 396 vma->fence->pin_count--; 397 } 398 399 /** 400 * i915_vma_unpin_fence - unpin fencing state 401 * @vma: vma to unpin fencing for 402 * 403 * This releases the fence pin reference acquired through 404 * i915_vma_pin_fence. It will handle both objects with and without an 405 * attached fence correctly, callers do not need to distinguish this. 406 */ 407 static inline void 408 i915_vma_unpin_fence(struct i915_vma *vma) 409 { 410 lockdep_assert_held(&vma->obj->base.dev->struct_mutex); 411 if (vma->fence) 412 __i915_vma_unpin_fence(vma); 413 } 414 415 void i915_vma_parked(struct drm_i915_private *i915); 416 417 #define for_each_until(cond) if (cond) break; else 418 419 /** 420 * for_each_ggtt_vma - Iterate over the GGTT VMA belonging to an object. 421 * @V: the #i915_vma iterator 422 * @OBJ: the #drm_i915_gem_object 423 * 424 * GGTT VMA are placed at the being of the object's vma_list, see 425 * vma_create(), so we can stop our walk as soon as we see a ppgtt VMA, 426 * or the list is empty ofc. 427 */ 428 #define for_each_ggtt_vma(V, OBJ) \ 429 list_for_each_entry(V, &(OBJ)->vma_list, obj_link) \ 430 for_each_until(!i915_vma_is_ggtt(V)) 431 432 #endif 433