1 /*
2 * SPDX-License-Identifier: MIT
3 *
4 * Copyright © 2016 Intel Corporation
5 */
6
7 #ifndef __I915_GEM_OBJECT_TYPES_H__
8 #define __I915_GEM_OBJECT_TYPES_H__
9
10 #include <linux/mmu_notifier.h>
11
12 #include <drm/drm_gem.h>
13 #include <drm/ttm/ttm_bo.h>
14 #include <uapi/drm/i915_drm.h>
15
16 #include "i915_active.h"
17 #include "i915_selftest.h"
18 #include "i915_vma_resource.h"
19
20 #include "gt/intel_gt_defines.h"
21
22 struct drm_i915_gem_object;
23 struct intel_fronbuffer;
24 struct intel_memory_region;
25
26 /*
27 * struct i915_lut_handle tracks the fast lookups from handle to vma used
28 * for execbuf. Although we use a radixtree for that mapping, in order to
29 * remove them as the object or context is closed, we need a secondary list
30 * and a translation entry (i915_lut_handle).
31 */
32 struct i915_lut_handle {
33 struct list_head obj_link;
34 struct i915_gem_context *ctx;
35 u32 handle;
36 };
37
38 struct drm_i915_gem_object_ops {
39 unsigned int flags;
40 #define I915_GEM_OBJECT_IS_SHRINKABLE BIT(1)
41 /* Skip the shrinker management in set_pages/unset_pages */
42 #define I915_GEM_OBJECT_SELF_MANAGED_SHRINK_LIST BIT(2)
43 #define I915_GEM_OBJECT_IS_PROXY BIT(3)
44 #define I915_GEM_OBJECT_NO_MMAP BIT(4)
45
46 /* Interface between the GEM object and its backing storage.
47 * get_pages() is called once prior to the use of the associated set
48 * of pages before to binding them into the GTT, and put_pages() is
49 * called after we no longer need them. As we expect there to be
50 * associated cost with migrating pages between the backing storage
51 * and making them available for the GPU (e.g. clflush), we may hold
52 * onto the pages after they are no longer referenced by the GPU
53 * in case they may be used again shortly (for example migrating the
54 * pages to a different memory domain within the GTT). put_pages()
55 * will therefore most likely be called when the object itself is
56 * being released or under memory pressure (where we attempt to
57 * reap pages for the shrinker).
58 */
59 int (*get_pages)(struct drm_i915_gem_object *obj);
60 void (*put_pages)(struct drm_i915_gem_object *obj,
61 struct sg_table *pages);
62 int (*truncate)(struct drm_i915_gem_object *obj);
63 /**
64 * shrink - Perform further backend specific actions to facilate
65 * shrinking.
66 * @obj: The gem object
67 * @flags: Extra flags to control shrinking behaviour in the backend
68 *
69 * Possible values for @flags:
70 *
71 * I915_GEM_OBJECT_SHRINK_WRITEBACK - Try to perform writeback of the
72 * backing pages, if supported.
73 *
74 * I915_GEM_OBJECT_SHRINK_NO_GPU_WAIT - Don't wait for the object to
75 * idle. Active objects can be considered later. The TTM backend for
76 * example might have aync migrations going on, which don't use any
77 * i915_vma to track the active GTT binding, and hence having an unbound
78 * object might not be enough.
79 */
80 #define I915_GEM_OBJECT_SHRINK_WRITEBACK BIT(0)
81 #define I915_GEM_OBJECT_SHRINK_NO_GPU_WAIT BIT(1)
82 int (*shrink)(struct drm_i915_gem_object *obj, unsigned int flags);
83
84 int (*pread)(struct drm_i915_gem_object *obj,
85 const struct drm_i915_gem_pread *arg);
86 int (*pwrite)(struct drm_i915_gem_object *obj,
87 const struct drm_i915_gem_pwrite *arg);
88 u64 (*mmap_offset)(struct drm_i915_gem_object *obj);
89 void (*unmap_virtual)(struct drm_i915_gem_object *obj);
90
91 int (*dmabuf_export)(struct drm_i915_gem_object *obj);
92
93 /**
94 * adjust_lru - notify that the madvise value was updated
95 * @obj: The gem object
96 *
97 * The madvise value may have been updated, or object was recently
98 * referenced so act accordingly (Perhaps changing an LRU list etc).
99 */
100 void (*adjust_lru)(struct drm_i915_gem_object *obj);
101
102 /**
103 * delayed_free - Override the default delayed free implementation
104 */
105 void (*delayed_free)(struct drm_i915_gem_object *obj);
106
107 /**
108 * migrate - Migrate object to a different region either for
109 * pinning or for as long as the object lock is held.
110 */
111 int (*migrate)(struct drm_i915_gem_object *obj,
112 struct intel_memory_region *mr,
113 unsigned int flags);
114
115 void (*release)(struct drm_i915_gem_object *obj);
116
117 #ifdef __linux__
118 const struct vm_operations_struct *mmap_ops;
119 #else
120 const struct uvm_pagerops *mmap_ops;
121 #endif
122 const char *name; /* friendly name for debug, e.g. lockdep classes */
123 };
124
125 /**
126 * enum i915_cache_level - The supported GTT caching values for system memory
127 * pages.
128 *
129 * These translate to some special GTT PTE bits when binding pages into some
130 * address space. It also determines whether an object, or rather its pages are
131 * coherent with the GPU, when also reading or writing through the CPU cache
132 * with those pages.
133 *
134 * Userspace can also control this through struct drm_i915_gem_caching.
135 */
136 enum i915_cache_level {
137 /**
138 * @I915_CACHE_NONE:
139 *
140 * GPU access is not coherent with the CPU cache. If the cache is dirty
141 * and we need the underlying pages to be coherent with some later GPU
142 * access then we need to manually flush the pages.
143 *
144 * On shared LLC platforms reads and writes through the CPU cache are
145 * still coherent even with this setting. See also
146 * &drm_i915_gem_object.cache_coherent for more details. Due to this we
147 * should only ever use uncached for scanout surfaces, otherwise we end
148 * up over-flushing in some places.
149 *
150 * This is the default on non-LLC platforms.
151 */
152 I915_CACHE_NONE = 0,
153 /**
154 * @I915_CACHE_LLC:
155 *
156 * GPU access is coherent with the CPU cache. If the cache is dirty,
157 * then the GPU will ensure that access remains coherent, when both
158 * reading and writing through the CPU cache. GPU writes can dirty the
159 * CPU cache.
160 *
161 * Not used for scanout surfaces.
162 *
163 * Applies to both platforms with shared LLC(HAS_LLC), and snooping
164 * based platforms(HAS_SNOOP).
165 *
166 * This is the default on shared LLC platforms. The only exception is
167 * scanout objects, where the display engine is not coherent with the
168 * CPU cache. For such objects I915_CACHE_NONE or I915_CACHE_WT is
169 * automatically applied by the kernel in pin_for_display, if userspace
170 * has not done so already.
171 */
172 I915_CACHE_LLC,
173 /**
174 * @I915_CACHE_L3_LLC:
175 *
176 * Explicitly enable the Gfx L3 cache, with coherent LLC.
177 *
178 * The Gfx L3 sits between the domain specific caches, e.g
179 * sampler/render caches, and the larger LLC. LLC is coherent with the
180 * GPU, but L3 is only visible to the GPU, so likely needs to be flushed
181 * when the workload completes.
182 *
183 * Not used for scanout surfaces.
184 *
185 * Only exposed on some gen7 + GGTT. More recent hardware has dropped
186 * this explicit setting, where it should now be enabled by default.
187 */
188 I915_CACHE_L3_LLC,
189 /**
190 * @I915_CACHE_WT:
191 *
192 * Write-through. Used for scanout surfaces.
193 *
194 * The GPU can utilise the caches, while still having the display engine
195 * be coherent with GPU writes, as a result we don't need to flush the
196 * CPU caches when moving out of the render domain. This is the default
197 * setting chosen by the kernel, if supported by the HW, otherwise we
198 * fallback to I915_CACHE_NONE. On the CPU side writes through the CPU
199 * cache still need to be flushed, to remain coherent with the display
200 * engine.
201 */
202 I915_CACHE_WT,
203 /**
204 * @I915_MAX_CACHE_LEVEL:
205 *
206 * Mark the last entry in the enum. Used for defining cachelevel_to_pat
207 * array for cache_level to pat translation table.
208 */
209 I915_MAX_CACHE_LEVEL,
210 };
211
212 enum i915_map_type {
213 I915_MAP_WB = 0,
214 I915_MAP_WC,
215 #define I915_MAP_OVERRIDE BIT(31)
216 I915_MAP_FORCE_WB = I915_MAP_WB | I915_MAP_OVERRIDE,
217 I915_MAP_FORCE_WC = I915_MAP_WC | I915_MAP_OVERRIDE,
218 };
219
220 enum i915_mmap_type {
221 I915_MMAP_TYPE_GTT = 0,
222 I915_MMAP_TYPE_WC,
223 I915_MMAP_TYPE_WB,
224 I915_MMAP_TYPE_UC,
225 I915_MMAP_TYPE_FIXED,
226 };
227
228 struct i915_mmap_offset {
229 struct drm_vma_offset_node vma_node;
230 struct drm_i915_gem_object *obj;
231 enum i915_mmap_type mmap_type;
232
233 struct rb_node offset;
234 };
235
236 struct i915_gem_object_page_iter {
237 struct scatterlist *sg_pos;
238 unsigned int sg_idx; /* in pages, but 32bit eek! */
239
240 struct radix_tree_root radix;
241 struct rwlock lock; /* protects this cache */
242 };
243
244 struct drm_i915_gem_object {
245 /*
246 * We might have reason to revisit the below since it wastes
247 * a lot of space for non-ttm gem objects.
248 * In any case, always use the accessors for the ttm_buffer_object
249 * when accessing it.
250 */
251 union {
252 struct drm_gem_object base;
253 struct ttm_buffer_object __do_not_access;
254 };
255
256 const struct drm_i915_gem_object_ops *ops;
257
258 struct {
259 /**
260 * @vma.lock: protect the list/tree of vmas
261 */
262 spinlock_t lock;
263
264 /**
265 * @vma.list: List of VMAs backed by this object
266 *
267 * The VMA on this list are ordered by type, all GGTT vma are
268 * placed at the head and all ppGTT vma are placed at the tail.
269 * The different types of GGTT vma are unordered between
270 * themselves, use the @vma.tree (which has a defined order
271 * between all VMA) to quickly find an exact match.
272 */
273 struct list_head list;
274
275 /**
276 * @vma.tree: Ordered tree of VMAs backed by this object
277 *
278 * All VMA created for this object are placed in the @vma.tree
279 * for fast retrieval via a binary search in
280 * i915_vma_instance(). They are also added to @vma.list for
281 * easy iteration.
282 */
283 struct rb_root tree;
284 } vma;
285
286 /**
287 * @lut_list: List of vma lookup entries in use for this object.
288 *
289 * If this object is closed, we need to remove all of its VMA from
290 * the fast lookup index in associated contexts; @lut_list provides
291 * this translation from object to context->handles_vma.
292 */
293 struct list_head lut_list;
294 spinlock_t lut_lock; /* guards lut_list */
295
296 /**
297 * @obj_link: Link into @i915_gem_ww_ctx.obj_list
298 *
299 * When we lock this object through i915_gem_object_lock() with a
300 * context, we add it to the list to ensure we can unlock everything
301 * when i915_gem_ww_ctx_backoff() or i915_gem_ww_ctx_fini() are called.
302 */
303 struct list_head obj_link;
304 /**
305 * @shared_resv_from: The object shares the resv from this vm.
306 */
307 struct i915_address_space *shares_resv_from;
308
309 #ifdef CONFIG_PROC_FS
310 /**
311 * @client: @i915_drm_client which created the object
312 */
313 struct i915_drm_client *client;
314
315 /**
316 * @client_link: Link into @i915_drm_client.objects_list
317 */
318 struct list_head client_link;
319 #endif
320
321 union {
322 struct rcu_head rcu;
323 struct llist_node freed;
324 };
325
326 /**
327 * Whether the object is currently in the GGTT or any other supported
328 * fake offset mmap backed by lmem.
329 */
330 unsigned int userfault_count;
331 struct list_head userfault_link;
332
333 struct {
334 spinlock_t lock; /* Protects access to mmo offsets */
335 struct rb_root offsets;
336 } mmo;
337
338 I915_SELFTEST_DECLARE(struct list_head st_link);
339
340 unsigned long flags;
341 #define I915_BO_ALLOC_CONTIGUOUS BIT(0)
342 #define I915_BO_ALLOC_VOLATILE BIT(1)
343 #define I915_BO_ALLOC_CPU_CLEAR BIT(2)
344 #define I915_BO_ALLOC_USER BIT(3)
345 /* Object is allowed to lose its contents on suspend / resume, even if pinned */
346 #define I915_BO_ALLOC_PM_VOLATILE BIT(4)
347 /* Object needs to be restored early using memcpy during resume */
348 #define I915_BO_ALLOC_PM_EARLY BIT(5)
349 /*
350 * Object is likely never accessed by the CPU. This will prioritise the BO to be
351 * allocated in the non-mappable portion of lmem. This is merely a hint, and if
352 * dealing with userspace objects the CPU fault handler is free to ignore this.
353 */
354 #define I915_BO_ALLOC_GPU_ONLY BIT(6)
355 #define I915_BO_ALLOC_CCS_AUX BIT(7)
356 /*
357 * Object is allowed to retain its initial data and will not be cleared on first
358 * access if used along with I915_BO_ALLOC_USER. This is mainly to keep
359 * preallocated framebuffer data intact while transitioning it to i915drmfb.
360 */
361 #define I915_BO_PREALLOC BIT(8)
362 #define I915_BO_ALLOC_FLAGS (I915_BO_ALLOC_CONTIGUOUS | \
363 I915_BO_ALLOC_VOLATILE | \
364 I915_BO_ALLOC_CPU_CLEAR | \
365 I915_BO_ALLOC_USER | \
366 I915_BO_ALLOC_PM_VOLATILE | \
367 I915_BO_ALLOC_PM_EARLY | \
368 I915_BO_ALLOC_GPU_ONLY | \
369 I915_BO_ALLOC_CCS_AUX | \
370 I915_BO_PREALLOC)
371 #define I915_BO_READONLY BIT(9)
372 #define I915_TILING_QUIRK_BIT 10 /* unknown swizzling; do not release! */
373 #define I915_BO_PROTECTED BIT(11)
374 /**
375 * @mem_flags - Mutable placement-related flags
376 *
377 * These are flags that indicate specifics of the memory region
378 * the object is currently in. As such they are only stable
379 * either under the object lock or if the object is pinned.
380 */
381 unsigned int mem_flags;
382 #define I915_BO_FLAG_STRUCT_PAGE BIT(0) /* Object backed by struct pages */
383 #define I915_BO_FLAG_IOMEM BIT(1) /* Object backed by IO memory */
384 /**
385 * @pat_index: The desired PAT index.
386 *
387 * See hardware specification for valid PAT indices for each platform.
388 * This field replaces the @cache_level that contains a value of enum
389 * i915_cache_level since PAT indices are being used by both userspace
390 * and kernel mode driver for caching policy control after GEN12.
391 * In the meantime platform specific tables are created to translate
392 * i915_cache_level into pat index, for more details check the macros
393 * defined i915/i915_pci.c, e.g. TGL_CACHELEVEL.
394 * For backward compatibility, this field contains values exactly match
395 * the entries of enum i915_cache_level for pre-GEN12 platforms (See
396 * LEGACY_CACHELEVEL), so that the PTE encode functions for these
397 * legacy platforms can stay the same.
398 */
399 unsigned int pat_index:6;
400 /**
401 * @pat_set_by_user: Indicate whether pat_index is set by user space
402 *
403 * This field is set to false by default, only set to true if the
404 * pat_index is set by user space. By design, user space is capable of
405 * managing caching behavior by setting pat_index, in which case this
406 * kernel mode driver should never touch the pat_index.
407 */
408 unsigned int pat_set_by_user:1;
409 /**
410 * @cache_coherent:
411 *
412 * Note: with the change above which replaced @cache_level with pat_index,
413 * the use of @cache_coherent is limited to the objects created by kernel
414 * or by userspace without pat index specified.
415 * Check for @pat_set_by_user to find out if an object has pat index set
416 * by userspace. The ioctl's to change cache settings have also been
417 * disabled for the objects with pat index set by userspace. Please don't
418 * assume @cache_coherent having the flags set as describe here. A helper
419 * function i915_gem_object_has_cache_level() provides one way to bypass
420 * the use of this field.
421 *
422 * Track whether the pages are coherent with the GPU if reading or
423 * writing through the CPU caches. The largely depends on the
424 * @cache_level setting.
425 *
426 * On platforms which don't have the shared LLC(HAS_SNOOP), like on Atom
427 * platforms, coherency must be explicitly requested with some special
428 * GTT caching bits(see enum i915_cache_level). When enabling coherency
429 * it does come at a performance and power cost on such platforms. On
430 * the flip side the kernel does not need to manually flush any buffers
431 * which need to be coherent with the GPU, if the object is not coherent
432 * i.e @cache_coherent is zero.
433 *
434 * On platforms that share the LLC with the CPU(HAS_LLC), all GT memory
435 * access will automatically snoop the CPU caches(even with CACHE_NONE).
436 * The one exception is when dealing with the display engine, like with
437 * scanout surfaces. To handle this the kernel will always flush the
438 * surface out of the CPU caches when preparing it for scanout. Also
439 * note that since scanout surfaces are only ever read by the display
440 * engine we only need to care about flushing any writes through the CPU
441 * cache, reads on the other hand will always be coherent.
442 *
443 * Something strange here is why @cache_coherent is not a simple
444 * boolean, i.e coherent vs non-coherent. The reasoning for this is back
445 * to the display engine not being fully coherent. As a result scanout
446 * surfaces will either be marked as I915_CACHE_NONE or I915_CACHE_WT.
447 * In the case of seeing I915_CACHE_NONE the kernel makes the assumption
448 * that this is likely a scanout surface, and will set @cache_coherent
449 * as only I915_BO_CACHE_COHERENT_FOR_READ, on platforms with the shared
450 * LLC. The kernel uses this to always flush writes through the CPU
451 * cache as early as possible, where it can, in effect keeping
452 * @cache_dirty clean, so we can potentially avoid stalling when
453 * flushing the surface just before doing the scanout. This does mean
454 * we might unnecessarily flush non-scanout objects in some places, but
455 * the default assumption is that all normal objects should be using
456 * I915_CACHE_LLC, at least on platforms with the shared LLC.
457 *
458 * Supported values:
459 *
460 * I915_BO_CACHE_COHERENT_FOR_READ:
461 *
462 * On shared LLC platforms, we use this for special scanout surfaces,
463 * where the display engine is not coherent with the CPU cache. As such
464 * we need to ensure we flush any writes before doing the scanout. As an
465 * optimisation we try to flush any writes as early as possible to avoid
466 * stalling later.
467 *
468 * Thus for scanout surfaces using I915_CACHE_NONE, on shared LLC
469 * platforms, we use:
470 *
471 * cache_coherent = I915_BO_CACHE_COHERENT_FOR_READ
472 *
473 * While for normal objects that are fully coherent, including special
474 * scanout surfaces marked as I915_CACHE_WT, we use:
475 *
476 * cache_coherent = I915_BO_CACHE_COHERENT_FOR_READ |
477 * I915_BO_CACHE_COHERENT_FOR_WRITE
478 *
479 * And then for objects that are not coherent at all we use:
480 *
481 * cache_coherent = 0
482 *
483 * I915_BO_CACHE_COHERENT_FOR_WRITE:
484 *
485 * When writing through the CPU cache, the GPU is still coherent. Note
486 * that this also implies I915_BO_CACHE_COHERENT_FOR_READ.
487 */
488 #define I915_BO_CACHE_COHERENT_FOR_READ BIT(0)
489 #define I915_BO_CACHE_COHERENT_FOR_WRITE BIT(1)
490 unsigned int cache_coherent:2;
491
492 /**
493 * @cache_dirty:
494 *
495 * Note: with the change above which replaced cache_level with pat_index,
496 * the use of @cache_dirty is limited to the objects created by kernel
497 * or by userspace without pat index specified.
498 * Check for @pat_set_by_user to find out if an object has pat index set
499 * by userspace. The ioctl's to change cache settings have also been
500 * disabled for the objects with pat_index set by userspace. Please don't
501 * assume @cache_dirty is set as describe here. Also see helper function
502 * i915_gem_object_has_cache_level() for possible ways to bypass the use
503 * of this field.
504 *
505 * Track if we are we dirty with writes through the CPU cache for this
506 * object. As a result reading directly from main memory might yield
507 * stale data.
508 *
509 * This also ties into whether the kernel is tracking the object as
510 * coherent with the GPU, as per @cache_coherent, as it determines if
511 * flushing might be needed at various points.
512 *
513 * Another part of @cache_dirty is managing flushing when first
514 * acquiring the pages for system memory, at this point the pages are
515 * considered foreign, so the default assumption is that the cache is
516 * dirty, for example the page zeroing done by the kernel might leave
517 * writes though the CPU cache, or swapping-in, while the actual data in
518 * main memory is potentially stale. Note that this is a potential
519 * security issue when dealing with userspace objects and zeroing. Now,
520 * whether we actually need apply the big sledgehammer of flushing all
521 * the pages on acquire depends on if @cache_coherent is marked as
522 * I915_BO_CACHE_COHERENT_FOR_WRITE, i.e that the GPU will be coherent
523 * for both reads and writes though the CPU cache.
524 *
525 * Note that on shared LLC platforms we still apply the heavy flush for
526 * I915_CACHE_NONE objects, under the assumption that this is going to
527 * be used for scanout.
528 *
529 * Update: On some hardware there is now also the 'Bypass LLC' MOCS
530 * entry, which defeats our @cache_coherent tracking, since userspace
531 * can freely bypass the CPU cache when touching the pages with the GPU,
532 * where the kernel is completely unaware. On such platform we need
533 * apply the sledgehammer-on-acquire regardless of the @cache_coherent.
534 *
535 * Special care is taken on non-LLC platforms, to prevent potential
536 * information leak. The driver currently ensures:
537 *
538 * 1. All userspace objects, by default, have @cache_level set as
539 * I915_CACHE_NONE. The only exception is userptr objects, where we
540 * instead force I915_CACHE_LLC, but we also don't allow userspace to
541 * ever change the @cache_level for such objects. Another special case
542 * is dma-buf, which doesn't rely on @cache_dirty, but there we
543 * always do a forced flush when acquiring the pages, if there is a
544 * chance that the pages can be read directly from main memory with
545 * the GPU.
546 *
547 * 2. All I915_CACHE_NONE objects have @cache_dirty initially true.
548 *
549 * 3. All swapped-out objects(i.e shmem) have @cache_dirty set to
550 * true.
551 *
552 * 4. The @cache_dirty is never freely reset before the initial
553 * flush, even if userspace adjusts the @cache_level through the
554 * i915_gem_set_caching_ioctl.
555 *
556 * 5. All @cache_dirty objects(including swapped-in) are initially
557 * flushed with a synchronous call to drm_clflush_sg in
558 * __i915_gem_object_set_pages. The @cache_dirty can be freely reset
559 * at this point. All further asynchronous clfushes are never security
560 * critical, i.e userspace is free to race against itself.
561 */
562 unsigned int cache_dirty:1;
563
564 /* @is_dpt: Object houses a display page table (DPT) */
565 unsigned int is_dpt:1;
566
567 /**
568 * @read_domains: Read memory domains.
569 *
570 * These monitor which caches contain read/write data related to the
571 * object. When transitioning from one set of domains to another,
572 * the driver is called to ensure that caches are suitably flushed and
573 * invalidated.
574 */
575 u16 read_domains;
576
577 /**
578 * @write_domain: Corresponding unique write memory domain.
579 */
580 u16 write_domain;
581
582 struct intel_frontbuffer __rcu *frontbuffer;
583
584 /** Current tiling stride for the object, if it's tiled. */
585 unsigned int tiling_and_stride;
586 #define FENCE_MINIMUM_STRIDE 128 /* See i915_tiling_ok() */
587 #define TILING_MASK (FENCE_MINIMUM_STRIDE - 1)
588 #define STRIDE_MASK (~TILING_MASK)
589
590 struct {
591 /*
592 * Protects the pages and their use. Do not use directly, but
593 * instead go through the pin/unpin interfaces.
594 */
595 atomic_t pages_pin_count;
596
597 /**
598 * @shrink_pin: Prevents the pages from being made visible to
599 * the shrinker, while the shrink_pin is non-zero. Most users
600 * should pretty much never have to care about this, outside of
601 * some special use cases.
602 *
603 * By default most objects will start out as visible to the
604 * shrinker(if I915_GEM_OBJECT_IS_SHRINKABLE) as soon as the
605 * backing pages are attached to the object, like in
606 * __i915_gem_object_set_pages(). They will then be removed the
607 * shrinker list once the pages are released.
608 *
609 * The @shrink_pin is incremented by calling
610 * i915_gem_object_make_unshrinkable(), which will also remove
611 * the object from the shrinker list, if the pin count was zero.
612 *
613 * Callers will then typically call
614 * i915_gem_object_make_shrinkable() or
615 * i915_gem_object_make_purgeable() to decrement the pin count,
616 * and make the pages visible again.
617 */
618 atomic_t shrink_pin;
619
620 /**
621 * @ttm_shrinkable: True when the object is using shmem pages
622 * underneath. Protected by the object lock.
623 */
624 bool ttm_shrinkable;
625
626 /**
627 * @unknown_state: Indicate that the object is effectively
628 * borked. This is write-once and set if we somehow encounter a
629 * fatal error when moving/clearing the pages, and we are not
630 * able to fallback to memcpy/memset, like on small-BAR systems.
631 * The GPU should also be wedged (or in the process) at this
632 * point.
633 *
634 * Only valid to read this after acquiring the dma-resv lock and
635 * waiting for all DMA_RESV_USAGE_KERNEL fences to be signalled,
636 * or if we otherwise know that the moving fence has signalled,
637 * and we are certain the pages underneath are valid for
638 * immediate access (under normal operation), like just prior to
639 * binding the object or when setting up the CPU fault handler.
640 * See i915_gem_object_has_unknown_state();
641 */
642 bool unknown_state;
643
644 /**
645 * Priority list of potential placements for this object.
646 */
647 struct intel_memory_region **placements;
648 int n_placements;
649
650 /**
651 * Memory region for this object.
652 */
653 struct intel_memory_region *region;
654
655 /**
656 * Memory manager resource allocated for this object. Only
657 * needed for the mock region.
658 */
659 struct ttm_resource *res;
660
661 /**
662 * Element within memory_region->objects or region->purgeable
663 * if the object is marked as DONTNEED. Access is protected by
664 * region->obj_lock.
665 */
666 struct list_head region_link;
667
668 struct i915_refct_sgt *rsgt;
669 struct sg_table *pages;
670 void *mapping;
671
672 struct i915_page_sizes page_sizes;
673
674 I915_SELFTEST_DECLARE(unsigned int page_mask);
675
676 struct i915_gem_object_page_iter get_page;
677 struct i915_gem_object_page_iter get_dma_page;
678
679 /**
680 * Element within i915->mm.shrink_list or i915->mm.purge_list,
681 * locked by i915->mm.obj_lock.
682 */
683 struct list_head link;
684
685 /**
686 * Advice: are the backing pages purgeable?
687 */
688 unsigned int madv:2;
689
690 /**
691 * This is set if the object has been written to since the
692 * pages were last acquired.
693 */
694 bool dirty:1;
695
696 u32 tlb[I915_MAX_GT];
697 } mm;
698
699 struct {
700 struct i915_refct_sgt *cached_io_rsgt;
701 struct i915_gem_object_page_iter get_io_page;
702 struct drm_i915_gem_object *backup;
703 bool created:1;
704 } ttm;
705
706 /*
707 * Record which PXP key instance this object was created against (if
708 * any), so we can use it to determine if the encryption is valid by
709 * comparing against the current key instance.
710 */
711 u32 pxp_key_instance;
712
713 /** Record of address bit 17 of each page at last unbind. */
714 unsigned long *bit_17;
715
716 union {
717 #ifdef CONFIG_MMU_NOTIFIER
718 struct i915_gem_userptr {
719 uintptr_t ptr;
720 unsigned long notifier_seq;
721
722 struct mmu_interval_notifier notifier;
723 struct page **pvec;
724 int page_ref;
725 } userptr;
726 #endif
727
728 struct drm_mm_node *stolen;
729
730 resource_size_t bo_offset;
731
732 unsigned long scratch;
733 u64 encode;
734
735 void *gvt_info;
736 };
737 };
738
739 #define intel_bo_to_drm_bo(bo) (&(bo)->base)
740 #define intel_bo_to_i915(bo) to_i915(intel_bo_to_drm_bo(bo)->dev)
741
742 static inline struct drm_i915_gem_object *
to_intel_bo(struct drm_gem_object * gem)743 to_intel_bo(struct drm_gem_object *gem)
744 {
745 /* Assert that to_intel_bo(NULL) == NULL */
746 BUILD_BUG_ON(offsetof(struct drm_i915_gem_object, base));
747
748 return container_of(gem, struct drm_i915_gem_object, base);
749 }
750
751 #endif
752