~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/drm/ttm/ttm_bo_driver.h

Version: ~ [ linux-5.7-rc7 ] ~ [ linux-5.6.14 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.42 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.124 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.181 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.224 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.224 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.84 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

  1 /**************************************************************************
  2  *
  3  * Copyright (c) 2006-2009 Vmware, Inc., Palo Alto, CA., USA
  4  * All Rights Reserved.
  5  *
  6  * Permission is hereby granted, free of charge, to any person obtaining a
  7  * copy of this software and associated documentation files (the
  8  * "Software"), to deal in the Software without restriction, including
  9  * without limitation the rights to use, copy, modify, merge, publish,
 10  * distribute, sub license, and/or sell copies of the Software, and to
 11  * permit persons to whom the Software is furnished to do so, subject to
 12  * the following conditions:
 13  *
 14  * The above copyright notice and this permission notice (including the
 15  * next paragraph) shall be included in all copies or substantial portions
 16  * of the Software.
 17  *
 18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
 21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
 22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
 23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
 24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
 25  *
 26  **************************************************************************/
 27 /*
 28  * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
 29  */
 30 #ifndef _TTM_BO_DRIVER_H_
 31 #define _TTM_BO_DRIVER_H_
 32 
 33 #include <ttm/ttm_bo_api.h>
 34 #include <ttm/ttm_memory.h>
 35 #include <ttm/ttm_module.h>
 36 #include <ttm/ttm_placement.h>
 37 #include <drm/drm_mm.h>
 38 #include <drm/drm_global.h>
 39 #include <drm/drm_vma_manager.h>
 40 #include <linux/workqueue.h>
 41 #include <linux/fs.h>
 42 #include <linux/spinlock.h>
 43 #include <linux/reservation.h>
 44 
 45 struct ttm_backend_func {
 46         /**
 47          * struct ttm_backend_func member bind
 48          *
 49          * @ttm: Pointer to a struct ttm_tt.
 50          * @bo_mem: Pointer to a struct ttm_mem_reg describing the
 51          * memory type and location for binding.
 52          *
 53          * Bind the backend pages into the aperture in the location
 54          * indicated by @bo_mem. This function should be able to handle
 55          * differences between aperture and system page sizes.
 56          */
 57         int (*bind) (struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
 58 
 59         /**
 60          * struct ttm_backend_func member unbind
 61          *
 62          * @ttm: Pointer to a struct ttm_tt.
 63          *
 64          * Unbind previously bound backend pages. This function should be
 65          * able to handle differences between aperture and system page sizes.
 66          */
 67         int (*unbind) (struct ttm_tt *ttm);
 68 
 69         /**
 70          * struct ttm_backend_func member destroy
 71          *
 72          * @ttm: Pointer to a struct ttm_tt.
 73          *
 74          * Destroy the backend. This will be call back from ttm_tt_destroy so
 75          * don't call ttm_tt_destroy from the callback or infinite loop.
 76          */
 77         void (*destroy) (struct ttm_tt *ttm);
 78 };
 79 
 80 #define TTM_PAGE_FLAG_WRITE           (1 << 3)
 81 #define TTM_PAGE_FLAG_SWAPPED         (1 << 4)
 82 #define TTM_PAGE_FLAG_PERSISTENT_SWAP (1 << 5)
 83 #define TTM_PAGE_FLAG_ZERO_ALLOC      (1 << 6)
 84 #define TTM_PAGE_FLAG_DMA32           (1 << 7)
 85 #define TTM_PAGE_FLAG_SG              (1 << 8)
 86 
 87 enum ttm_caching_state {
 88         tt_uncached,
 89         tt_wc,
 90         tt_cached
 91 };
 92 
 93 /**
 94  * struct ttm_tt
 95  *
 96  * @bdev: Pointer to a struct ttm_bo_device.
 97  * @func: Pointer to a struct ttm_backend_func that describes
 98  * the backend methods.
 99  * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL
100  * pointer.
101  * @pages: Array of pages backing the data.
102  * @num_pages: Number of pages in the page array.
103  * @bdev: Pointer to the current struct ttm_bo_device.
104  * @be: Pointer to the ttm backend.
105  * @swap_storage: Pointer to shmem struct file for swap storage.
106  * @caching_state: The current caching state of the pages.
107  * @state: The current binding state of the pages.
108  *
109  * This is a structure holding the pages, caching- and aperture binding
110  * status for a buffer object that isn't backed by fixed (VRAM / AGP)
111  * memory.
112  */
113 
114 struct ttm_tt {
115         struct ttm_bo_device *bdev;
116         struct ttm_backend_func *func;
117         struct page *dummy_read_page;
118         struct page **pages;
119         uint32_t page_flags;
120         unsigned long num_pages;
121         struct sg_table *sg; /* for SG objects via dma-buf */
122         struct ttm_bo_global *glob;
123         struct file *swap_storage;
124         enum ttm_caching_state caching_state;
125         enum {
126                 tt_bound,
127                 tt_unbound,
128                 tt_unpopulated,
129         } state;
130 };
131 
132 /**
133  * struct ttm_dma_tt
134  *
135  * @ttm: Base ttm_tt struct.
136  * @cpu_address: The CPU address of the pages
137  * @dma_address: The DMA (bus) addresses of the pages
138  * @pages_list: used by some page allocation backend
139  *
140  * This is a structure holding the pages, caching- and aperture binding
141  * status for a buffer object that isn't backed by fixed (VRAM / AGP)
142  * memory.
143  */
144 struct ttm_dma_tt {
145         struct ttm_tt ttm;
146         void **cpu_address;
147         dma_addr_t *dma_address;
148         struct list_head pages_list;
149 };
150 
151 #define TTM_MEMTYPE_FLAG_FIXED         (1 << 0) /* Fixed (on-card) PCI memory */
152 #define TTM_MEMTYPE_FLAG_MAPPABLE      (1 << 1) /* Memory mappable */
153 #define TTM_MEMTYPE_FLAG_CMA           (1 << 3) /* Can't map aperture */
154 
155 struct ttm_mem_type_manager;
156 
157 struct ttm_mem_type_manager_func {
158         /**
159          * struct ttm_mem_type_manager member init
160          *
161          * @man: Pointer to a memory type manager.
162          * @p_size: Implementation dependent, but typically the size of the
163          * range to be managed in pages.
164          *
165          * Called to initialize a private range manager. The function is
166          * expected to initialize the man::priv member.
167          * Returns 0 on success, negative error code on failure.
168          */
169         int  (*init)(struct ttm_mem_type_manager *man, unsigned long p_size);
170 
171         /**
172          * struct ttm_mem_type_manager member takedown
173          *
174          * @man: Pointer to a memory type manager.
175          *
176          * Called to undo the setup done in init. All allocated resources
177          * should be freed.
178          */
179         int  (*takedown)(struct ttm_mem_type_manager *man);
180 
181         /**
182          * struct ttm_mem_type_manager member get_node
183          *
184          * @man: Pointer to a memory type manager.
185          * @bo: Pointer to the buffer object we're allocating space for.
186          * @placement: Placement details.
187          * @flags: Additional placement flags.
188          * @mem: Pointer to a struct ttm_mem_reg to be filled in.
189          *
190          * This function should allocate space in the memory type managed
191          * by @man. Placement details if
192          * applicable are given by @placement. If successful,
193          * @mem::mm_node should be set to a non-null value, and
194          * @mem::start should be set to a value identifying the beginning
195          * of the range allocated, and the function should return zero.
196          * If the memory region accommodate the buffer object, @mem::mm_node
197          * should be set to NULL, and the function should return 0.
198          * If a system error occurred, preventing the request to be fulfilled,
199          * the function should return a negative error code.
200          *
201          * Note that @mem::mm_node will only be dereferenced by
202          * struct ttm_mem_type_manager functions and optionally by the driver,
203          * which has knowledge of the underlying type.
204          *
205          * This function may not be called from within atomic context, so
206          * an implementation can and must use either a mutex or a spinlock to
207          * protect any data structures managing the space.
208          */
209         int  (*get_node)(struct ttm_mem_type_manager *man,
210                          struct ttm_buffer_object *bo,
211                          const struct ttm_place *place,
212                          struct ttm_mem_reg *mem);
213 
214         /**
215          * struct ttm_mem_type_manager member put_node
216          *
217          * @man: Pointer to a memory type manager.
218          * @mem: Pointer to a struct ttm_mem_reg to be filled in.
219          *
220          * This function frees memory type resources previously allocated
221          * and that are identified by @mem::mm_node and @mem::start. May not
222          * be called from within atomic context.
223          */
224         void (*put_node)(struct ttm_mem_type_manager *man,
225                          struct ttm_mem_reg *mem);
226 
227         /**
228          * struct ttm_mem_type_manager member debug
229          *
230          * @man: Pointer to a memory type manager.
231          * @prefix: Prefix to be used in printout to identify the caller.
232          *
233          * This function is called to print out the state of the memory
234          * type manager to aid debugging of out-of-memory conditions.
235          * It may not be called from within atomic context.
236          */
237         void (*debug)(struct ttm_mem_type_manager *man, const char *prefix);
238 };
239 
240 /**
241  * struct ttm_mem_type_manager
242  *
243  * @has_type: The memory type has been initialized.
244  * @use_type: The memory type is enabled.
245  * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory
246  * managed by this memory type.
247  * @gpu_offset: If used, the GPU offset of the first managed page of
248  * fixed memory or the first managed location in an aperture.
249  * @size: Size of the managed region.
250  * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX,
251  * as defined in ttm_placement_common.h
252  * @default_caching: The default caching policy used for a buffer object
253  * placed in this memory type if the user doesn't provide one.
254  * @func: structure pointer implementing the range manager. See above
255  * @priv: Driver private closure for @func.
256  * @io_reserve_mutex: Mutex optionally protecting shared io_reserve structures
257  * @use_io_reserve_lru: Use an lru list to try to unreserve io_mem_regions
258  * reserved by the TTM vm system.
259  * @io_reserve_lru: Optional lru list for unreserving io mem regions.
260  * @io_reserve_fastpath: Only use bdev::driver::io_mem_reserve to obtain
261  * @move_lock: lock for move fence
262  * static information. bdev::driver::io_mem_free is never used.
263  * @lru: The lru list for this memory type.
264  * @move: The fence of the last pipelined move operation.
265  *
266  * This structure is used to identify and manage memory types for a device.
267  * It's set up by the ttm_bo_driver::init_mem_type method.
268  */
269 
270 
271 
272 struct ttm_mem_type_manager {
273         struct ttm_bo_device *bdev;
274 
275         /*
276          * No protection. Constant from start.
277          */
278 
279         bool has_type;
280         bool use_type;
281         uint32_t flags;
282         uint64_t gpu_offset; /* GPU address space is independent of CPU word size */
283         uint64_t size;
284         uint32_t available_caching;
285         uint32_t default_caching;
286         const struct ttm_mem_type_manager_func *func;
287         void *priv;
288         struct mutex io_reserve_mutex;
289         bool use_io_reserve_lru;
290         bool io_reserve_fastpath;
291         spinlock_t move_lock;
292 
293         /*
294          * Protected by @io_reserve_mutex:
295          */
296 
297         struct list_head io_reserve_lru;
298 
299         /*
300          * Protected by the global->lru_lock.
301          */
302 
303         struct list_head lru;
304 
305         /*
306          * Protected by @move_lock.
307          */
308         struct fence *move;
309 };
310 
311 /**
312  * struct ttm_bo_driver
313  *
314  * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
315  * @invalidate_caches: Callback to invalidate read caches when a buffer object
316  * has been evicted.
317  * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager
318  * structure.
319  * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
320  * @move: Callback for a driver to hook in accelerated functions to
321  * move a buffer.
322  * If set to NULL, a potentially slow memcpy() move is used.
323  */
324 
325 struct ttm_bo_driver {
326         /**
327          * ttm_tt_create
328          *
329          * @bdev: pointer to a struct ttm_bo_device:
330          * @size: Size of the data needed backing.
331          * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
332          * @dummy_read_page: See struct ttm_bo_device.
333          *
334          * Create a struct ttm_tt to back data with system memory pages.
335          * No pages are actually allocated.
336          * Returns:
337          * NULL: Out of memory.
338          */
339         struct ttm_tt *(*ttm_tt_create)(struct ttm_bo_device *bdev,
340                                         unsigned long size,
341                                         uint32_t page_flags,
342                                         struct page *dummy_read_page);
343 
344         /**
345          * ttm_tt_populate
346          *
347          * @ttm: The struct ttm_tt to contain the backing pages.
348          *
349          * Allocate all backing pages
350          * Returns:
351          * -ENOMEM: Out of memory.
352          */
353         int (*ttm_tt_populate)(struct ttm_tt *ttm);
354 
355         /**
356          * ttm_tt_unpopulate
357          *
358          * @ttm: The struct ttm_tt to contain the backing pages.
359          *
360          * Free all backing page
361          */
362         void (*ttm_tt_unpopulate)(struct ttm_tt *ttm);
363 
364         /**
365          * struct ttm_bo_driver member invalidate_caches
366          *
367          * @bdev: the buffer object device.
368          * @flags: new placement of the rebound buffer object.
369          *
370          * A previosly evicted buffer has been rebound in a
371          * potentially new location. Tell the driver that it might
372          * consider invalidating read (texture) caches on the next command
373          * submission as a consequence.
374          */
375 
376         int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags);
377         int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type,
378                               struct ttm_mem_type_manager *man);
379         /**
380          * struct ttm_bo_driver member evict_flags:
381          *
382          * @bo: the buffer object to be evicted
383          *
384          * Return the bo flags for a buffer which is not mapped to the hardware.
385          * These will be placed in proposed_flags so that when the move is
386          * finished, they'll end up in bo->mem.flags
387          */
388 
389          void(*evict_flags) (struct ttm_buffer_object *bo,
390                                 struct ttm_placement *placement);
391         /**
392          * struct ttm_bo_driver member move:
393          *
394          * @bo: the buffer to move
395          * @evict: whether this motion is evicting the buffer from
396          * the graphics address space
397          * @interruptible: Use interruptible sleeps if possible when sleeping.
398          * @no_wait: whether this should give up and return -EBUSY
399          * if this move would require sleeping
400          * @new_mem: the new memory region receiving the buffer
401          *
402          * Move a buffer between two memory regions.
403          */
404         int (*move) (struct ttm_buffer_object *bo,
405                      bool evict, bool interruptible,
406                      bool no_wait_gpu,
407                      struct ttm_mem_reg *new_mem);
408 
409         /**
410          * struct ttm_bo_driver_member verify_access
411          *
412          * @bo: Pointer to a buffer object.
413          * @filp: Pointer to a struct file trying to access the object.
414          *
415          * Called from the map / write / read methods to verify that the
416          * caller is permitted to access the buffer object.
417          * This member may be set to NULL, which will refuse this kind of
418          * access for all buffer objects.
419          * This function should return 0 if access is granted, -EPERM otherwise.
420          */
421         int (*verify_access) (struct ttm_buffer_object *bo,
422                               struct file *filp);
423 
424         /* hook to notify driver about a driver move so it
425          * can do tiling things */
426         void (*move_notify)(struct ttm_buffer_object *bo,
427                             struct ttm_mem_reg *new_mem);
428         /* notify the driver we are taking a fault on this BO
429          * and have reserved it */
430         int (*fault_reserve_notify)(struct ttm_buffer_object *bo);
431 
432         /**
433          * notify the driver that we're about to swap out this bo
434          */
435         void (*swap_notify) (struct ttm_buffer_object *bo);
436 
437         /**
438          * Driver callback on when mapping io memory (for bo_move_memcpy
439          * for instance). TTM will take care to call io_mem_free whenever
440          * the mapping is not use anymore. io_mem_reserve & io_mem_free
441          * are balanced.
442          */
443         int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
444         void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
445 
446         /**
447          * Optional driver callback for when BO is removed from the LRU.
448          * Called with LRU lock held immediately before the removal.
449          */
450         void (*lru_removal)(struct ttm_buffer_object *bo);
451 
452         /**
453          * Return the list_head after which a BO should be inserted in the LRU.
454          */
455         struct list_head *(*lru_tail)(struct ttm_buffer_object *bo);
456         struct list_head *(*swap_lru_tail)(struct ttm_buffer_object *bo);
457 };
458 
459 /**
460  * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
461  */
462 
463 struct ttm_bo_global_ref {
464         struct drm_global_reference ref;
465         struct ttm_mem_global *mem_glob;
466 };
467 
468 /**
469  * struct ttm_bo_global - Buffer object driver global data.
470  *
471  * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
472  * @dummy_read_page: Pointer to a dummy page used for mapping requests
473  * of unpopulated pages.
474  * @shrink: A shrink callback object used for buffer object swap.
475  * @device_list_mutex: Mutex protecting the device list.
476  * This mutex is held while traversing the device list for pm options.
477  * @lru_lock: Spinlock protecting the bo subsystem lru lists.
478  * @device_list: List of buffer object devices.
479  * @swap_lru: Lru list of buffer objects used for swapping.
480  */
481 
482 struct ttm_bo_global {
483 
484         /**
485          * Constant after init.
486          */
487 
488         struct kobject kobj;
489         struct ttm_mem_global *mem_glob;
490         struct page *dummy_read_page;
491         struct ttm_mem_shrink shrink;
492         struct mutex device_list_mutex;
493         spinlock_t lru_lock;
494 
495         /**
496          * Protected by device_list_mutex.
497          */
498         struct list_head device_list;
499 
500         /**
501          * Protected by the lru_lock.
502          */
503         struct list_head swap_lru;
504 
505         /**
506          * Internal protection.
507          */
508         atomic_t bo_count;
509 };
510 
511 
512 #define TTM_NUM_MEM_TYPES 8
513 
514 /**
515  * struct ttm_bo_device - Buffer object driver device-specific data.
516  *
517  * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
518  * @man: An array of mem_type_managers.
519  * @vma_manager: Address space manager
520  * lru_lock: Spinlock that protects the buffer+device lru lists and
521  * ddestroy lists.
522  * @dev_mapping: A pointer to the struct address_space representing the
523  * device address space.
524  * @wq: Work queue structure for the delayed delete workqueue.
525  *
526  */
527 
528 struct ttm_bo_device {
529 
530         /*
531          * Constant after bo device init / atomic.
532          */
533         struct list_head device_list;
534         struct ttm_bo_global *glob;
535         struct ttm_bo_driver *driver;
536         struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
537 
538         /*
539          * Protected by internal locks.
540          */
541         struct drm_vma_offset_manager vma_manager;
542 
543         /*
544          * Protected by the global:lru lock.
545          */
546         struct list_head ddestroy;
547 
548         /*
549          * Protected by load / firstopen / lastclose /unload sync.
550          */
551 
552         struct address_space *dev_mapping;
553 
554         /*
555          * Internal protection.
556          */
557 
558         struct delayed_work wq;
559 
560         bool need_dma32;
561 };
562 
563 /**
564  * ttm_flag_masked
565  *
566  * @old: Pointer to the result and original value.
567  * @new: New value of bits.
568  * @mask: Mask of bits to change.
569  *
570  * Convenience function to change a number of bits identified by a mask.
571  */
572 
573 static inline uint32_t
574 ttm_flag_masked(uint32_t *old, uint32_t new, uint32_t mask)
575 {
576         *old ^= (*old ^ new) & mask;
577         return *old;
578 }
579 
580 /**
581  * ttm_tt_init
582  *
583  * @ttm: The struct ttm_tt.
584  * @bdev: pointer to a struct ttm_bo_device:
585  * @size: Size of the data needed backing.
586  * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
587  * @dummy_read_page: See struct ttm_bo_device.
588  *
589  * Create a struct ttm_tt to back data with system memory pages.
590  * No pages are actually allocated.
591  * Returns:
592  * NULL: Out of memory.
593  */
594 extern int ttm_tt_init(struct ttm_tt *ttm, struct ttm_bo_device *bdev,
595                         unsigned long size, uint32_t page_flags,
596                         struct page *dummy_read_page);
597 extern int ttm_dma_tt_init(struct ttm_dma_tt *ttm_dma, struct ttm_bo_device *bdev,
598                            unsigned long size, uint32_t page_flags,
599                            struct page *dummy_read_page);
600 
601 /**
602  * ttm_tt_fini
603  *
604  * @ttm: the ttm_tt structure.
605  *
606  * Free memory of ttm_tt structure
607  */
608 extern void ttm_tt_fini(struct ttm_tt *ttm);
609 extern void ttm_dma_tt_fini(struct ttm_dma_tt *ttm_dma);
610 
611 /**
612  * ttm_ttm_bind:
613  *
614  * @ttm: The struct ttm_tt containing backing pages.
615  * @bo_mem: The struct ttm_mem_reg identifying the binding location.
616  *
617  * Bind the pages of @ttm to an aperture location identified by @bo_mem
618  */
619 extern int ttm_tt_bind(struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
620 
621 /**
622  * ttm_ttm_destroy:
623  *
624  * @ttm: The struct ttm_tt.
625  *
626  * Unbind, unpopulate and destroy common struct ttm_tt.
627  */
628 extern void ttm_tt_destroy(struct ttm_tt *ttm);
629 
630 /**
631  * ttm_ttm_unbind:
632  *
633  * @ttm: The struct ttm_tt.
634  *
635  * Unbind a struct ttm_tt.
636  */
637 extern void ttm_tt_unbind(struct ttm_tt *ttm);
638 
639 /**
640  * ttm_tt_swapin:
641  *
642  * @ttm: The struct ttm_tt.
643  *
644  * Swap in a previously swap out ttm_tt.
645  */
646 extern int ttm_tt_swapin(struct ttm_tt *ttm);
647 
648 /**
649  * ttm_tt_set_placement_caching:
650  *
651  * @ttm A struct ttm_tt the backing pages of which will change caching policy.
652  * @placement: Flag indicating the desired caching policy.
653  *
654  * This function will change caching policy of any default kernel mappings of
655  * the pages backing @ttm. If changing from cached to uncached or
656  * write-combined,
657  * all CPU caches will first be flushed to make sure the data of the pages
658  * hit RAM. This function may be very costly as it involves global TLB
659  * and cache flushes and potential page splitting / combining.
660  */
661 extern int ttm_tt_set_placement_caching(struct ttm_tt *ttm, uint32_t placement);
662 extern int ttm_tt_swapout(struct ttm_tt *ttm,
663                           struct file *persistent_swap_storage);
664 
665 /**
666  * ttm_tt_unpopulate - free pages from a ttm
667  *
668  * @ttm: Pointer to the ttm_tt structure
669  *
670  * Calls the driver method to free all pages from a ttm
671  */
672 extern void ttm_tt_unpopulate(struct ttm_tt *ttm);
673 
674 /*
675  * ttm_bo.c
676  */
677 
678 /**
679  * ttm_mem_reg_is_pci
680  *
681  * @bdev: Pointer to a struct ttm_bo_device.
682  * @mem: A valid struct ttm_mem_reg.
683  *
684  * Returns true if the memory described by @mem is PCI memory,
685  * false otherwise.
686  */
687 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev,
688                                    struct ttm_mem_reg *mem);
689 
690 /**
691  * ttm_bo_mem_space
692  *
693  * @bo: Pointer to a struct ttm_buffer_object. the data of which
694  * we want to allocate space for.
695  * @proposed_placement: Proposed new placement for the buffer object.
696  * @mem: A struct ttm_mem_reg.
697  * @interruptible: Sleep interruptible when sliping.
698  * @no_wait_gpu: Return immediately if the GPU is busy.
699  *
700  * Allocate memory space for the buffer object pointed to by @bo, using
701  * the placement flags in @mem, potentially evicting other idle buffer objects.
702  * This function may sleep while waiting for space to become available.
703  * Returns:
704  * -EBUSY: No space available (only if no_wait == 1).
705  * -ENOMEM: Could not allocate memory for the buffer object, either due to
706  * fragmentation or concurrent allocators.
707  * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
708  */
709 extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
710                                 struct ttm_placement *placement,
711                                 struct ttm_mem_reg *mem,
712                                 bool interruptible,
713                                 bool no_wait_gpu);
714 
715 extern void ttm_bo_mem_put(struct ttm_buffer_object *bo,
716                            struct ttm_mem_reg *mem);
717 extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo,
718                                   struct ttm_mem_reg *mem);
719 
720 extern void ttm_bo_global_release(struct drm_global_reference *ref);
721 extern int ttm_bo_global_init(struct drm_global_reference *ref);
722 
723 extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
724 
725 /**
726  * ttm_bo_device_init
727  *
728  * @bdev: A pointer to a struct ttm_bo_device to initialize.
729  * @glob: A pointer to an initialized struct ttm_bo_global.
730  * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
731  * @mapping: The address space to use for this bo.
732  * @file_page_offset: Offset into the device address space that is available
733  * for buffer data. This ensures compatibility with other users of the
734  * address space.
735  *
736  * Initializes a struct ttm_bo_device:
737  * Returns:
738  * !0: Failure.
739  */
740 extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
741                               struct ttm_bo_global *glob,
742                               struct ttm_bo_driver *driver,
743                               struct address_space *mapping,
744                               uint64_t file_page_offset, bool need_dma32);
745 
746 /**
747  * ttm_bo_unmap_virtual
748  *
749  * @bo: tear down the virtual mappings for this BO
750  */
751 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
752 
753 /**
754  * ttm_bo_unmap_virtual
755  *
756  * @bo: tear down the virtual mappings for this BO
757  *
758  * The caller must take ttm_mem_io_lock before calling this function.
759  */
760 extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo);
761 
762 extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo);
763 extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo);
764 extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man,
765                            bool interruptible);
766 extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man);
767 
768 extern void ttm_bo_del_sub_from_lru(struct ttm_buffer_object *bo);
769 extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo);
770 
771 struct list_head *ttm_bo_default_lru_tail(struct ttm_buffer_object *bo);
772 struct list_head *ttm_bo_default_swap_lru_tail(struct ttm_buffer_object *bo);
773 
774 /**
775  * __ttm_bo_reserve:
776  *
777  * @bo: A pointer to a struct ttm_buffer_object.
778  * @interruptible: Sleep interruptible if waiting.
779  * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
780  * @ticket: ticket used to acquire the ww_mutex.
781  *
782  * Will not remove reserved buffers from the lru lists.
783  * Otherwise identical to ttm_bo_reserve.
784  *
785  * Returns:
786  * -EDEADLK: The reservation may cause a deadlock.
787  * Release all buffer reservations, wait for @bo to become unreserved and
788  * try again. (only if use_sequence == 1).
789  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
790  * a signal. Release all buffer reservations and return to user-space.
791  * -EBUSY: The function needed to sleep, but @no_wait was true
792  * -EALREADY: Bo already reserved using @ticket. This error code will only
793  * be returned if @use_ticket is set to true.
794  */
795 static inline int __ttm_bo_reserve(struct ttm_buffer_object *bo,
796                                    bool interruptible, bool no_wait,
797                                    struct ww_acquire_ctx *ticket)
798 {
799         int ret = 0;
800 
801         if (no_wait) {
802                 bool success;
803                 if (WARN_ON(ticket))
804                         return -EBUSY;
805 
806                 success = ww_mutex_trylock(&bo->resv->lock);
807                 return success ? 0 : -EBUSY;
808         }
809 
810         if (interruptible)
811                 ret = ww_mutex_lock_interruptible(&bo->resv->lock, ticket);
812         else
813                 ret = ww_mutex_lock(&bo->resv->lock, ticket);
814         if (ret == -EINTR)
815                 return -ERESTARTSYS;
816         return ret;
817 }
818 
819 /**
820  * ttm_bo_reserve:
821  *
822  * @bo: A pointer to a struct ttm_buffer_object.
823  * @interruptible: Sleep interruptible if waiting.
824  * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
825  * @ticket: ticket used to acquire the ww_mutex.
826  *
827  * Locks a buffer object for validation. (Or prevents other processes from
828  * locking it for validation) and removes it from lru lists, while taking
829  * a number of measures to prevent deadlocks.
830  *
831  * Deadlocks may occur when two processes try to reserve multiple buffers in
832  * different order, either by will or as a result of a buffer being evicted
833  * to make room for a buffer already reserved. (Buffers are reserved before
834  * they are evicted). The following algorithm prevents such deadlocks from
835  * occurring:
836  * Processes attempting to reserve multiple buffers other than for eviction,
837  * (typically execbuf), should first obtain a unique 32-bit
838  * validation sequence number,
839  * and call this function with @use_ticket == 1 and @ticket->stamp == the unique
840  * sequence number. If upon call of this function, the buffer object is already
841  * reserved, the validation sequence is checked against the validation
842  * sequence of the process currently reserving the buffer,
843  * and if the current validation sequence is greater than that of the process
844  * holding the reservation, the function returns -EDEADLK. Otherwise it sleeps
845  * waiting for the buffer to become unreserved, after which it retries
846  * reserving.
847  * The caller should, when receiving an -EDEADLK error
848  * release all its buffer reservations, wait for @bo to become unreserved, and
849  * then rerun the validation with the same validation sequence. This procedure
850  * will always guarantee that the process with the lowest validation sequence
851  * will eventually succeed, preventing both deadlocks and starvation.
852  *
853  * Returns:
854  * -EDEADLK: The reservation may cause a deadlock.
855  * Release all buffer reservations, wait for @bo to become unreserved and
856  * try again. (only if use_sequence == 1).
857  * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
858  * a signal. Release all buffer reservations and return to user-space.
859  * -EBUSY: The function needed to sleep, but @no_wait was true
860  * -EALREADY: Bo already reserved using @ticket. This error code will only
861  * be returned if @use_ticket is set to true.
862  */
863 static inline int ttm_bo_reserve(struct ttm_buffer_object *bo,
864                                  bool interruptible, bool no_wait,
865                                  struct ww_acquire_ctx *ticket)
866 {
867         int ret;
868 
869         WARN_ON(!atomic_read(&bo->kref.refcount));
870 
871         ret = __ttm_bo_reserve(bo, interruptible, no_wait, ticket);
872         if (likely(ret == 0))
873                 ttm_bo_del_sub_from_lru(bo);
874 
875         return ret;
876 }
877 
878 /**
879  * ttm_bo_reserve_slowpath:
880  * @bo: A pointer to a struct ttm_buffer_object.
881  * @interruptible: Sleep interruptible if waiting.
882  * @sequence: Set (@bo)->sequence to this value after lock
883  *
884  * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
885  * from all our other reservations. Because there are no other reservations
886  * held by us, this function cannot deadlock any more.
887  */
888 static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo,
889                                           bool interruptible,
890                                           struct ww_acquire_ctx *ticket)
891 {
892         int ret = 0;
893 
894         WARN_ON(!atomic_read(&bo->kref.refcount));
895 
896         if (interruptible)
897                 ret = ww_mutex_lock_slow_interruptible(&bo->resv->lock,
898                                                        ticket);
899         else
900                 ww_mutex_lock_slow(&bo->resv->lock, ticket);
901 
902         if (likely(ret == 0))
903                 ttm_bo_del_sub_from_lru(bo);
904         else if (ret == -EINTR)
905                 ret = -ERESTARTSYS;
906 
907         return ret;
908 }
909 
910 /**
911  * __ttm_bo_unreserve
912  * @bo: A pointer to a struct ttm_buffer_object.
913  *
914  * Unreserve a previous reservation of @bo where the buffer object is
915  * already on lru lists.
916  */
917 static inline void __ttm_bo_unreserve(struct ttm_buffer_object *bo)
918 {
919         ww_mutex_unlock(&bo->resv->lock);
920 }
921 
922 /**
923  * ttm_bo_unreserve
924  *
925  * @bo: A pointer to a struct ttm_buffer_object.
926  *
927  * Unreserve a previous reservation of @bo.
928  */
929 static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo)
930 {
931         if (!(bo->mem.placement & TTM_PL_FLAG_NO_EVICT)) {
932                 spin_lock(&bo->glob->lru_lock);
933                 ttm_bo_add_to_lru(bo);
934                 spin_unlock(&bo->glob->lru_lock);
935         }
936         __ttm_bo_unreserve(bo);
937 }
938 
939 /**
940  * ttm_bo_unreserve_ticket
941  * @bo: A pointer to a struct ttm_buffer_object.
942  * @ticket: ww_acquire_ctx used for reserving
943  *
944  * Unreserve a previous reservation of @bo made with @ticket.
945  */
946 static inline void ttm_bo_unreserve_ticket(struct ttm_buffer_object *bo,
947                                            struct ww_acquire_ctx *t)
948 {
949         ttm_bo_unreserve(bo);
950 }
951 
952 /*
953  * ttm_bo_util.c
954  */
955 
956 int ttm_mem_io_reserve(struct ttm_bo_device *bdev,
957                        struct ttm_mem_reg *mem);
958 void ttm_mem_io_free(struct ttm_bo_device *bdev,
959                      struct ttm_mem_reg *mem);
960 /**
961  * ttm_bo_move_ttm
962  *
963  * @bo: A pointer to a struct ttm_buffer_object.
964  * @evict: 1: This is an eviction. Don't try to pipeline.
965  * @interruptible: Sleep interruptible if waiting.
966  * @no_wait_gpu: Return immediately if the GPU is busy.
967  * @new_mem: struct ttm_mem_reg indicating where to move.
968  *
969  * Optimized move function for a buffer object with both old and
970  * new placement backed by a TTM. The function will, if successful,
971  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
972  * and update the (@bo)->mem placement flags. If unsuccessful, the old
973  * data remains untouched, and it's up to the caller to free the
974  * memory space indicated by @new_mem.
975  * Returns:
976  * !0: Failure.
977  */
978 
979 extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
980                            bool evict, bool interruptible, bool no_wait_gpu,
981                            struct ttm_mem_reg *new_mem);
982 
983 /**
984  * ttm_bo_move_memcpy
985  *
986  * @bo: A pointer to a struct ttm_buffer_object.
987  * @evict: 1: This is an eviction. Don't try to pipeline.
988  * @interruptible: Sleep interruptible if waiting.
989  * @no_wait_gpu: Return immediately if the GPU is busy.
990  * @new_mem: struct ttm_mem_reg indicating where to move.
991  *
992  * Fallback move function for a mappable buffer object in mappable memory.
993  * The function will, if successful,
994  * free any old aperture space, and set (@new_mem)->mm_node to NULL,
995  * and update the (@bo)->mem placement flags. If unsuccessful, the old
996  * data remains untouched, and it's up to the caller to free the
997  * memory space indicated by @new_mem.
998  * Returns:
999  * !0: Failure.
1000  */
1001 
1002 extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
1003                               bool evict, bool interruptible,
1004                               bool no_wait_gpu,
1005                               struct ttm_mem_reg *new_mem);
1006 
1007 /**
1008  * ttm_bo_free_old_node
1009  *
1010  * @bo: A pointer to a struct ttm_buffer_object.
1011  *
1012  * Utility function to free an old placement after a successful move.
1013  */
1014 extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
1015 
1016 /**
1017  * ttm_bo_move_accel_cleanup.
1018  *
1019  * @bo: A pointer to a struct ttm_buffer_object.
1020  * @fence: A fence object that signals when moving is complete.
1021  * @evict: This is an evict move. Don't return until the buffer is idle.
1022  * @new_mem: struct ttm_mem_reg indicating where to move.
1023  *
1024  * Accelerated move function to be called when an accelerated move
1025  * has been scheduled. The function will create a new temporary buffer object
1026  * representing the old placement, and put the sync object on both buffer
1027  * objects. After that the newly created buffer object is unref'd to be
1028  * destroyed when the move is complete. This will help pipeline
1029  * buffer moves.
1030  */
1031 
1032 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
1033                                      struct fence *fence, bool evict,
1034                                      struct ttm_mem_reg *new_mem);
1035 
1036 /**
1037  * ttm_bo_pipeline_move.
1038  *
1039  * @bo: A pointer to a struct ttm_buffer_object.
1040  * @fence: A fence object that signals when moving is complete.
1041  * @evict: This is an evict move. Don't return until the buffer is idle.
1042  * @new_mem: struct ttm_mem_reg indicating where to move.
1043  *
1044  * Function for pipelining accelerated moves. Either free the memory
1045  * immediately or hang it on a temporary buffer object.
1046  */
1047 int ttm_bo_pipeline_move(struct ttm_buffer_object *bo,
1048                          struct fence *fence, bool evict,
1049                          struct ttm_mem_reg *new_mem);
1050 
1051 /**
1052  * ttm_io_prot
1053  *
1054  * @c_state: Caching state.
1055  * @tmp: Page protection flag for a normal, cached mapping.
1056  *
1057  * Utility function that returns the pgprot_t that should be used for
1058  * setting up a PTE with the caching model indicated by @c_state.
1059  */
1060 extern pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
1061 
1062 extern const struct ttm_mem_type_manager_func ttm_bo_manager_func;
1063 
1064 #if IS_ENABLED(CONFIG_AGP)
1065 #include <linux/agp_backend.h>
1066 
1067 /**
1068  * ttm_agp_tt_create
1069  *
1070  * @bdev: Pointer to a struct ttm_bo_device.
1071  * @bridge: The agp bridge this device is sitting on.
1072  * @size: Size of the data needed backing.
1073  * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
1074  * @dummy_read_page: See struct ttm_bo_device.
1075  *
1076  *
1077  * Create a TTM backend that uses the indicated AGP bridge as an aperture
1078  * for TT memory. This function uses the linux agpgart interface to
1079  * bind and unbind memory backing a ttm_tt.
1080  */
1081 extern struct ttm_tt *ttm_agp_tt_create(struct ttm_bo_device *bdev,
1082                                         struct agp_bridge_data *bridge,
1083                                         unsigned long size, uint32_t page_flags,
1084                                         struct page *dummy_read_page);
1085 int ttm_agp_tt_populate(struct ttm_tt *ttm);
1086 void ttm_agp_tt_unpopulate(struct ttm_tt *ttm);
1087 #endif
1088 
1089 #endif
1090 

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp