1 /**************************************************************************
3 * Copyright (c) 2006-2009 Vmware, Inc., Palo Alto, CA., USA
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
28 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
30 #ifndef _TTM_BO_DRIVER_H_
31 #define _TTM_BO_DRIVER_H_
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>
42 #include <linux/spinlock.h>
43 #include <linux/reservation.h>
45 struct ttm_backend_func
{
47 * struct ttm_backend_func member bind
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.
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.
57 int (*bind
) (struct ttm_tt
*ttm
, struct ttm_mem_reg
*bo_mem
);
60 * struct ttm_backend_func member unbind
62 * @ttm: Pointer to a struct ttm_tt.
64 * Unbind previously bound backend pages. This function should be
65 * able to handle differences between aperture and system page sizes.
67 int (*unbind
) (struct ttm_tt
*ttm
);
70 * struct ttm_backend_func member destroy
72 * @ttm: Pointer to a struct ttm_tt.
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.
77 void (*destroy
) (struct ttm_tt
*ttm
);
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)
87 enum ttm_caching_state
{
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
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.
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)
115 struct ttm_bo_device
*bdev
;
116 struct ttm_backend_func
*func
;
117 struct page
*dummy_read_page
;
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
;
135 * @ttm: Base ttm_tt struct.
136 * @dma_address: The DMA (bus) addresses of the pages
137 * @pages_list: used by some page allocation backend
139 * This is a structure holding the pages, caching- and aperture binding
140 * status for a buffer object that isn't backed by fixed (VRAM / AGP)
145 dma_addr_t
*dma_address
;
146 struct list_head pages_list
;
149 #define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */
150 #define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */
151 #define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */
153 struct ttm_mem_type_manager
;
155 struct ttm_mem_type_manager_func
{
157 * struct ttm_mem_type_manager member init
159 * @man: Pointer to a memory type manager.
160 * @p_size: Implementation dependent, but typically the size of the
161 * range to be managed in pages.
163 * Called to initialize a private range manager. The function is
164 * expected to initialize the man::priv member.
165 * Returns 0 on success, negative error code on failure.
167 int (*init
)(struct ttm_mem_type_manager
*man
, unsigned long p_size
);
170 * struct ttm_mem_type_manager member takedown
172 * @man: Pointer to a memory type manager.
174 * Called to undo the setup done in init. All allocated resources
177 int (*takedown
)(struct ttm_mem_type_manager
*man
);
180 * struct ttm_mem_type_manager member get_node
182 * @man: Pointer to a memory type manager.
183 * @bo: Pointer to the buffer object we're allocating space for.
184 * @placement: Placement details.
185 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
187 * This function should allocate space in the memory type managed
188 * by @man. Placement details if
189 * applicable are given by @placement. If successful,
190 * @mem::mm_node should be set to a non-null value, and
191 * @mem::start should be set to a value identifying the beginning
192 * of the range allocated, and the function should return zero.
193 * If the memory region accommodate the buffer object, @mem::mm_node
194 * should be set to NULL, and the function should return 0.
195 * If a system error occurred, preventing the request to be fulfilled,
196 * the function should return a negative error code.
198 * Note that @mem::mm_node will only be dereferenced by
199 * struct ttm_mem_type_manager functions and optionally by the driver,
200 * which has knowledge of the underlying type.
202 * This function may not be called from within atomic context, so
203 * an implementation can and must use either a mutex or a spinlock to
204 * protect any data structures managing the space.
206 int (*get_node
)(struct ttm_mem_type_manager
*man
,
207 struct ttm_buffer_object
*bo
,
208 struct ttm_placement
*placement
,
209 struct ttm_mem_reg
*mem
);
212 * struct ttm_mem_type_manager member put_node
214 * @man: Pointer to a memory type manager.
215 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
217 * This function frees memory type resources previously allocated
218 * and that are identified by @mem::mm_node and @mem::start. May not
219 * be called from within atomic context.
221 void (*put_node
)(struct ttm_mem_type_manager
*man
,
222 struct ttm_mem_reg
*mem
);
225 * struct ttm_mem_type_manager member debug
227 * @man: Pointer to a memory type manager.
228 * @prefix: Prefix to be used in printout to identify the caller.
230 * This function is called to print out the state of the memory
231 * type manager to aid debugging of out-of-memory conditions.
232 * It may not be called from within atomic context.
234 void (*debug
)(struct ttm_mem_type_manager
*man
, const char *prefix
);
238 * struct ttm_mem_type_manager
240 * @has_type: The memory type has been initialized.
241 * @use_type: The memory type is enabled.
242 * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory
243 * managed by this memory type.
244 * @gpu_offset: If used, the GPU offset of the first managed page of
245 * fixed memory or the first managed location in an aperture.
246 * @size: Size of the managed region.
247 * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX,
248 * as defined in ttm_placement_common.h
249 * @default_caching: The default caching policy used for a buffer object
250 * placed in this memory type if the user doesn't provide one.
251 * @func: structure pointer implementing the range manager. See above
252 * @priv: Driver private closure for @func.
253 * @io_reserve_mutex: Mutex optionally protecting shared io_reserve structures
254 * @use_io_reserve_lru: Use an lru list to try to unreserve io_mem_regions
255 * reserved by the TTM vm system.
256 * @io_reserve_lru: Optional lru list for unreserving io mem regions.
257 * @io_reserve_fastpath: Only use bdev::driver::io_mem_reserve to obtain
258 * static information. bdev::driver::io_mem_free is never used.
259 * @lru: The lru list for this memory type.
261 * This structure is used to identify and manage memory types for a device.
262 * It's set up by the ttm_bo_driver::init_mem_type method.
267 struct ttm_mem_type_manager
{
268 struct ttm_bo_device
*bdev
;
271 * No protection. Constant from start.
277 unsigned long gpu_offset
;
279 uint32_t available_caching
;
280 uint32_t default_caching
;
281 const struct ttm_mem_type_manager_func
*func
;
283 struct mutex io_reserve_mutex
;
284 bool use_io_reserve_lru
;
285 bool io_reserve_fastpath
;
288 * Protected by @io_reserve_mutex:
291 struct list_head io_reserve_lru
;
294 * Protected by the global->lru_lock.
297 struct list_head lru
;
301 * struct ttm_bo_driver
303 * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
304 * @invalidate_caches: Callback to invalidate read caches when a buffer object
306 * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager
308 * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
309 * @move: Callback for a driver to hook in accelerated functions to
311 * If set to NULL, a potentially slow memcpy() move is used.
312 * @sync_obj_signaled: See ttm_fence_api.h
313 * @sync_obj_wait: See ttm_fence_api.h
314 * @sync_obj_flush: See ttm_fence_api.h
315 * @sync_obj_unref: See ttm_fence_api.h
316 * @sync_obj_ref: See ttm_fence_api.h
319 struct ttm_bo_driver
{
323 * @bdev: pointer to a struct ttm_bo_device:
324 * @size: Size of the data needed backing.
325 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
326 * @dummy_read_page: See struct ttm_bo_device.
328 * Create a struct ttm_tt to back data with system memory pages.
329 * No pages are actually allocated.
331 * NULL: Out of memory.
333 struct ttm_tt
*(*ttm_tt_create
)(struct ttm_bo_device
*bdev
,
336 struct page
*dummy_read_page
);
341 * @ttm: The struct ttm_tt to contain the backing pages.
343 * Allocate all backing pages
345 * -ENOMEM: Out of memory.
347 int (*ttm_tt_populate
)(struct ttm_tt
*ttm
);
352 * @ttm: The struct ttm_tt to contain the backing pages.
354 * Free all backing page
356 void (*ttm_tt_unpopulate
)(struct ttm_tt
*ttm
);
359 * struct ttm_bo_driver member invalidate_caches
361 * @bdev: the buffer object device.
362 * @flags: new placement of the rebound buffer object.
364 * A previosly evicted buffer has been rebound in a
365 * potentially new location. Tell the driver that it might
366 * consider invalidating read (texture) caches on the next command
367 * submission as a consequence.
370 int (*invalidate_caches
) (struct ttm_bo_device
*bdev
, uint32_t flags
);
371 int (*init_mem_type
) (struct ttm_bo_device
*bdev
, uint32_t type
,
372 struct ttm_mem_type_manager
*man
);
374 * struct ttm_bo_driver member evict_flags:
376 * @bo: the buffer object to be evicted
378 * Return the bo flags for a buffer which is not mapped to the hardware.
379 * These will be placed in proposed_flags so that when the move is
380 * finished, they'll end up in bo->mem.flags
383 void(*evict_flags
) (struct ttm_buffer_object
*bo
,
384 struct ttm_placement
*placement
);
386 * struct ttm_bo_driver member move:
388 * @bo: the buffer to move
389 * @evict: whether this motion is evicting the buffer from
390 * the graphics address space
391 * @interruptible: Use interruptible sleeps if possible when sleeping.
392 * @no_wait: whether this should give up and return -EBUSY
393 * if this move would require sleeping
394 * @new_mem: the new memory region receiving the buffer
396 * Move a buffer between two memory regions.
398 int (*move
) (struct ttm_buffer_object
*bo
,
399 bool evict
, bool interruptible
,
401 struct ttm_mem_reg
*new_mem
);
404 * struct ttm_bo_driver_member verify_access
406 * @bo: Pointer to a buffer object.
407 * @filp: Pointer to a struct file trying to access the object.
409 * Called from the map / write / read methods to verify that the
410 * caller is permitted to access the buffer object.
411 * This member may be set to NULL, which will refuse this kind of
412 * access for all buffer objects.
413 * This function should return 0 if access is granted, -EPERM otherwise.
415 int (*verify_access
) (struct ttm_buffer_object
*bo
,
419 * In case a driver writer dislikes the TTM fence objects,
420 * the driver writer can replace those with sync objects of
421 * his / her own. If it turns out that no driver writer is
422 * using these. I suggest we remove these hooks and plug in
423 * fences directly. The bo driver needs the following functionality:
424 * See the corresponding functions in the fence object API
428 bool (*sync_obj_signaled
) (void *sync_obj
);
429 int (*sync_obj_wait
) (void *sync_obj
,
430 bool lazy
, bool interruptible
);
431 int (*sync_obj_flush
) (void *sync_obj
);
432 void (*sync_obj_unref
) (void **sync_obj
);
433 void *(*sync_obj_ref
) (void *sync_obj
);
435 /* hook to notify driver about a driver move so it
436 * can do tiling things */
437 void (*move_notify
)(struct ttm_buffer_object
*bo
,
438 struct ttm_mem_reg
*new_mem
);
439 /* notify the driver we are taking a fault on this BO
440 * and have reserved it */
441 int (*fault_reserve_notify
)(struct ttm_buffer_object
*bo
);
444 * notify the driver that we're about to swap out this bo
446 void (*swap_notify
) (struct ttm_buffer_object
*bo
);
449 * Driver callback on when mapping io memory (for bo_move_memcpy
450 * for instance). TTM will take care to call io_mem_free whenever
451 * the mapping is not use anymore. io_mem_reserve & io_mem_free
454 int (*io_mem_reserve
)(struct ttm_bo_device
*bdev
, struct ttm_mem_reg
*mem
);
455 void (*io_mem_free
)(struct ttm_bo_device
*bdev
, struct ttm_mem_reg
*mem
);
459 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
462 struct ttm_bo_global_ref
{
463 struct drm_global_reference ref
;
464 struct ttm_mem_global
*mem_glob
;
468 * struct ttm_bo_global - Buffer object driver global data.
470 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
471 * @dummy_read_page: Pointer to a dummy page used for mapping requests
472 * of unpopulated pages.
473 * @shrink: A shrink callback object used for buffer object swap.
474 * @device_list_mutex: Mutex protecting the device list.
475 * This mutex is held while traversing the device list for pm options.
476 * @lru_lock: Spinlock protecting the bo subsystem lru lists.
477 * @device_list: List of buffer object devices.
478 * @swap_lru: Lru list of buffer objects used for swapping.
481 struct ttm_bo_global
{
484 * Constant after init.
488 struct ttm_mem_global
*mem_glob
;
489 struct page
*dummy_read_page
;
490 struct ttm_mem_shrink shrink
;
491 struct mutex device_list_mutex
;
495 * Protected by device_list_mutex.
497 struct list_head device_list
;
500 * Protected by the lru_lock.
502 struct list_head swap_lru
;
505 * Internal protection.
511 #define TTM_NUM_MEM_TYPES 8
513 #define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs
514 idling before CPU mapping */
515 #define TTM_BO_PRIV_FLAG_MAX 1
517 * struct ttm_bo_device - Buffer object driver device-specific data.
519 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
520 * @man: An array of mem_type_managers.
521 * @fence_lock: Protects the synchronizing members on *all* bos belonging
523 * @vma_manager: Address space manager
524 * lru_lock: Spinlock that protects the buffer+device lru lists and
526 * @val_seq: Current validation sequence.
527 * @dev_mapping: A pointer to the struct address_space representing the
528 * device address space.
529 * @wq: Work queue structure for the delayed delete workqueue.
533 struct ttm_bo_device
{
536 * Constant after bo device init / atomic.
538 struct list_head device_list
;
539 struct ttm_bo_global
*glob
;
540 struct ttm_bo_driver
*driver
;
541 struct ttm_mem_type_manager man
[TTM_NUM_MEM_TYPES
];
542 spinlock_t fence_lock
;
545 * Protected by internal locks.
547 struct drm_vma_offset_manager vma_manager
;
550 * Protected by the global:lru lock.
552 struct list_head ddestroy
;
556 * Protected by load / firstopen / lastclose /unload sync.
559 struct address_space
*dev_mapping
;
562 * Internal protection.
565 struct delayed_work wq
;
573 * @old: Pointer to the result and original value.
574 * @new: New value of bits.
575 * @mask: Mask of bits to change.
577 * Convenience function to change a number of bits identified by a mask.
580 static inline uint32_t
581 ttm_flag_masked(uint32_t *old
, uint32_t new, uint32_t mask
)
583 *old
^= (*old
^ new) & mask
;
590 * @ttm: The struct ttm_tt.
591 * @bdev: pointer to a struct ttm_bo_device:
592 * @size: Size of the data needed backing.
593 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
594 * @dummy_read_page: See struct ttm_bo_device.
596 * Create a struct ttm_tt to back data with system memory pages.
597 * No pages are actually allocated.
599 * NULL: Out of memory.
601 extern int ttm_tt_init(struct ttm_tt
*ttm
, struct ttm_bo_device
*bdev
,
602 unsigned long size
, uint32_t page_flags
,
603 struct page
*dummy_read_page
);
604 extern int ttm_dma_tt_init(struct ttm_dma_tt
*ttm_dma
, struct ttm_bo_device
*bdev
,
605 unsigned long size
, uint32_t page_flags
,
606 struct page
*dummy_read_page
);
611 * @ttm: the ttm_tt structure.
613 * Free memory of ttm_tt structure
615 extern void ttm_tt_fini(struct ttm_tt
*ttm
);
616 extern void ttm_dma_tt_fini(struct ttm_dma_tt
*ttm_dma
);
621 * @ttm: The struct ttm_tt containing backing pages.
622 * @bo_mem: The struct ttm_mem_reg identifying the binding location.
624 * Bind the pages of @ttm to an aperture location identified by @bo_mem
626 extern int ttm_tt_bind(struct ttm_tt
*ttm
, struct ttm_mem_reg
*bo_mem
);
631 * @ttm: The struct ttm_tt.
633 * Unbind, unpopulate and destroy common struct ttm_tt.
635 extern void ttm_tt_destroy(struct ttm_tt
*ttm
);
640 * @ttm: The struct ttm_tt.
642 * Unbind a struct ttm_tt.
644 extern void ttm_tt_unbind(struct ttm_tt
*ttm
);
649 * @ttm: The struct ttm_tt.
651 * Swap in a previously swap out ttm_tt.
653 extern int ttm_tt_swapin(struct ttm_tt
*ttm
);
656 * ttm_tt_cache_flush:
658 * @pages: An array of pointers to struct page:s to flush.
659 * @num_pages: Number of pages to flush.
661 * Flush the data of the indicated pages from the cpu caches.
662 * This is used when changing caching attributes of the pages from
665 extern void ttm_tt_cache_flush(struct page
*pages
[], unsigned long num_pages
);
668 * ttm_tt_set_placement_caching:
670 * @ttm A struct ttm_tt the backing pages of which will change caching policy.
671 * @placement: Flag indicating the desired caching policy.
673 * This function will change caching policy of any default kernel mappings of
674 * the pages backing @ttm. If changing from cached to uncached or
676 * all CPU caches will first be flushed to make sure the data of the pages
677 * hit RAM. This function may be very costly as it involves global TLB
678 * and cache flushes and potential page splitting / combining.
680 extern int ttm_tt_set_placement_caching(struct ttm_tt
*ttm
, uint32_t placement
);
681 extern int ttm_tt_swapout(struct ttm_tt
*ttm
,
682 struct file
*persistent_swap_storage
);
685 * ttm_tt_unpopulate - free pages from a ttm
687 * @ttm: Pointer to the ttm_tt structure
689 * Calls the driver method to free all pages from a ttm
691 extern void ttm_tt_unpopulate(struct ttm_tt
*ttm
);
700 * @bdev: Pointer to a struct ttm_bo_device.
701 * @mem: A valid struct ttm_mem_reg.
703 * Returns true if the memory described by @mem is PCI memory,
706 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device
*bdev
,
707 struct ttm_mem_reg
*mem
);
712 * @bo: Pointer to a struct ttm_buffer_object. the data of which
713 * we want to allocate space for.
714 * @proposed_placement: Proposed new placement for the buffer object.
715 * @mem: A struct ttm_mem_reg.
716 * @interruptible: Sleep interruptible when sliping.
717 * @no_wait_gpu: Return immediately if the GPU is busy.
719 * Allocate memory space for the buffer object pointed to by @bo, using
720 * the placement flags in @mem, potentially evicting other idle buffer objects.
721 * This function may sleep while waiting for space to become available.
723 * -EBUSY: No space available (only if no_wait == 1).
724 * -ENOMEM: Could not allocate memory for the buffer object, either due to
725 * fragmentation or concurrent allocators.
726 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
728 extern int ttm_bo_mem_space(struct ttm_buffer_object
*bo
,
729 struct ttm_placement
*placement
,
730 struct ttm_mem_reg
*mem
,
734 extern void ttm_bo_mem_put(struct ttm_buffer_object
*bo
,
735 struct ttm_mem_reg
*mem
);
736 extern void ttm_bo_mem_put_locked(struct ttm_buffer_object
*bo
,
737 struct ttm_mem_reg
*mem
);
739 extern void ttm_bo_global_release(struct drm_global_reference
*ref
);
740 extern int ttm_bo_global_init(struct drm_global_reference
*ref
);
742 extern int ttm_bo_device_release(struct ttm_bo_device
*bdev
);
747 * @bdev: A pointer to a struct ttm_bo_device to initialize.
748 * @glob: A pointer to an initialized struct ttm_bo_global.
749 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
750 * @mapping: The address space to use for this bo.
751 * @file_page_offset: Offset into the device address space that is available
752 * for buffer data. This ensures compatibility with other users of the
755 * Initializes a struct ttm_bo_device:
759 extern int ttm_bo_device_init(struct ttm_bo_device
*bdev
,
760 struct ttm_bo_global
*glob
,
761 struct ttm_bo_driver
*driver
,
762 struct address_space
*mapping
,
763 uint64_t file_page_offset
, bool need_dma32
);
766 * ttm_bo_unmap_virtual
768 * @bo: tear down the virtual mappings for this BO
770 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object
*bo
);
773 * ttm_bo_unmap_virtual
775 * @bo: tear down the virtual mappings for this BO
777 * The caller must take ttm_mem_io_lock before calling this function.
779 extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object
*bo
);
781 extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object
*bo
);
782 extern void ttm_mem_io_free_vm(struct ttm_buffer_object
*bo
);
783 extern int ttm_mem_io_lock(struct ttm_mem_type_manager
*man
,
785 extern void ttm_mem_io_unlock(struct ttm_mem_type_manager
*man
);
787 extern void ttm_bo_del_sub_from_lru(struct ttm_buffer_object
*bo
);
788 extern void ttm_bo_add_to_lru(struct ttm_buffer_object
*bo
);
793 * @bo: A pointer to a struct ttm_buffer_object.
794 * @interruptible: Sleep interruptible if waiting.
795 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
796 * @use_ticket: If @bo is already reserved, Only sleep waiting for
797 * it to become unreserved if @ticket->stamp is older.
799 * Will not remove reserved buffers from the lru lists.
800 * Otherwise identical to ttm_bo_reserve.
803 * -EDEADLK: The reservation may cause a deadlock.
804 * Release all buffer reservations, wait for @bo to become unreserved and
805 * try again. (only if use_sequence == 1).
806 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
807 * a signal. Release all buffer reservations and return to user-space.
808 * -EBUSY: The function needed to sleep, but @no_wait was true
809 * -EALREADY: Bo already reserved using @ticket. This error code will only
810 * be returned if @use_ticket is set to true.
812 static inline int __ttm_bo_reserve(struct ttm_buffer_object
*bo
,
814 bool no_wait
, bool use_ticket
,
815 struct ww_acquire_ctx
*ticket
)
824 success
= ww_mutex_trylock(&bo
->resv
->lock
);
825 return success
? 0 : -EBUSY
;
829 ret
= ww_mutex_lock_interruptible(&bo
->resv
->lock
, ticket
);
831 ret
= ww_mutex_lock(&bo
->resv
->lock
, ticket
);
840 * @bo: A pointer to a struct ttm_buffer_object.
841 * @interruptible: Sleep interruptible if waiting.
842 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
843 * @use_ticket: If @bo is already reserved, Only sleep waiting for
844 * it to become unreserved if @ticket->stamp is older.
846 * Locks a buffer object for validation. (Or prevents other processes from
847 * locking it for validation) and removes it from lru lists, while taking
848 * a number of measures to prevent deadlocks.
850 * Deadlocks may occur when two processes try to reserve multiple buffers in
851 * different order, either by will or as a result of a buffer being evicted
852 * to make room for a buffer already reserved. (Buffers are reserved before
853 * they are evicted). The following algorithm prevents such deadlocks from
855 * Processes attempting to reserve multiple buffers other than for eviction,
856 * (typically execbuf), should first obtain a unique 32-bit
857 * validation sequence number,
858 * and call this function with @use_ticket == 1 and @ticket->stamp == the unique
859 * sequence number. If upon call of this function, the buffer object is already
860 * reserved, the validation sequence is checked against the validation
861 * sequence of the process currently reserving the buffer,
862 * and if the current validation sequence is greater than that of the process
863 * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps
864 * waiting for the buffer to become unreserved, after which it retries
866 * The caller should, when receiving an -EAGAIN error
867 * release all its buffer reservations, wait for @bo to become unreserved, and
868 * then rerun the validation with the same validation sequence. This procedure
869 * will always guarantee that the process with the lowest validation sequence
870 * will eventually succeed, preventing both deadlocks and starvation.
873 * -EDEADLK: The reservation may cause a deadlock.
874 * Release all buffer reservations, wait for @bo to become unreserved and
875 * try again. (only if use_sequence == 1).
876 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
877 * a signal. Release all buffer reservations and return to user-space.
878 * -EBUSY: The function needed to sleep, but @no_wait was true
879 * -EALREADY: Bo already reserved using @ticket. This error code will only
880 * be returned if @use_ticket is set to true.
882 static inline int ttm_bo_reserve(struct ttm_buffer_object
*bo
,
884 bool no_wait
, bool use_ticket
,
885 struct ww_acquire_ctx
*ticket
)
889 WARN_ON(!atomic_read(&bo
->kref
.refcount
));
891 ret
= __ttm_bo_reserve(bo
, interruptible
, no_wait
, use_ticket
, ticket
);
892 if (likely(ret
== 0))
893 ttm_bo_del_sub_from_lru(bo
);
899 * ttm_bo_reserve_slowpath:
900 * @bo: A pointer to a struct ttm_buffer_object.
901 * @interruptible: Sleep interruptible if waiting.
902 * @sequence: Set (@bo)->sequence to this value after lock
904 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
905 * from all our other reservations. Because there are no other reservations
906 * held by us, this function cannot deadlock any more.
908 static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object
*bo
,
910 struct ww_acquire_ctx
*ticket
)
914 WARN_ON(!atomic_read(&bo
->kref
.refcount
));
917 ret
= ww_mutex_lock_slow_interruptible(&bo
->resv
->lock
,
920 ww_mutex_lock_slow(&bo
->resv
->lock
, ticket
);
922 if (likely(ret
== 0))
923 ttm_bo_del_sub_from_lru(bo
);
924 else if (ret
== -EINTR
)
932 * @bo: A pointer to a struct ttm_buffer_object.
934 * Unreserve a previous reservation of @bo where the buffer object is
935 * already on lru lists.
937 static inline void __ttm_bo_unreserve(struct ttm_buffer_object
*bo
)
939 ww_mutex_unlock(&bo
->resv
->lock
);
945 * @bo: A pointer to a struct ttm_buffer_object.
947 * Unreserve a previous reservation of @bo.
949 static inline void ttm_bo_unreserve(struct ttm_buffer_object
*bo
)
951 if (!(bo
->mem
.placement
& TTM_PL_FLAG_NO_EVICT
)) {
952 spin_lock(&bo
->glob
->lru_lock
);
953 ttm_bo_add_to_lru(bo
);
954 spin_unlock(&bo
->glob
->lru_lock
);
956 __ttm_bo_unreserve(bo
);
960 * ttm_bo_unreserve_ticket
961 * @bo: A pointer to a struct ttm_buffer_object.
962 * @ticket: ww_acquire_ctx used for reserving
964 * Unreserve a previous reservation of @bo made with @ticket.
966 static inline void ttm_bo_unreserve_ticket(struct ttm_buffer_object
*bo
,
967 struct ww_acquire_ctx
*t
)
969 ttm_bo_unreserve(bo
);
976 int ttm_mem_io_reserve(struct ttm_bo_device
*bdev
,
977 struct ttm_mem_reg
*mem
);
978 void ttm_mem_io_free(struct ttm_bo_device
*bdev
,
979 struct ttm_mem_reg
*mem
);
983 * @bo: A pointer to a struct ttm_buffer_object.
984 * @evict: 1: This is an eviction. Don't try to pipeline.
985 * @no_wait_gpu: Return immediately if the GPU is busy.
986 * @new_mem: struct ttm_mem_reg indicating where to move.
988 * Optimized move function for a buffer object with both old and
989 * new placement backed by a TTM. The function will, if successful,
990 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
991 * and update the (@bo)->mem placement flags. If unsuccessful, the old
992 * data remains untouched, and it's up to the caller to free the
993 * memory space indicated by @new_mem.
998 extern int ttm_bo_move_ttm(struct ttm_buffer_object
*bo
,
999 bool evict
, bool no_wait_gpu
,
1000 struct ttm_mem_reg
*new_mem
);
1003 * ttm_bo_move_memcpy
1005 * @bo: A pointer to a struct ttm_buffer_object.
1006 * @evict: 1: This is an eviction. Don't try to pipeline.
1007 * @no_wait_gpu: Return immediately if the GPU is busy.
1008 * @new_mem: struct ttm_mem_reg indicating where to move.
1010 * Fallback move function for a mappable buffer object in mappable memory.
1011 * The function will, if successful,
1012 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
1013 * and update the (@bo)->mem placement flags. If unsuccessful, the old
1014 * data remains untouched, and it's up to the caller to free the
1015 * memory space indicated by @new_mem.
1020 extern int ttm_bo_move_memcpy(struct ttm_buffer_object
*bo
,
1021 bool evict
, bool no_wait_gpu
,
1022 struct ttm_mem_reg
*new_mem
);
1025 * ttm_bo_free_old_node
1027 * @bo: A pointer to a struct ttm_buffer_object.
1029 * Utility function to free an old placement after a successful move.
1031 extern void ttm_bo_free_old_node(struct ttm_buffer_object
*bo
);
1034 * ttm_bo_move_accel_cleanup.
1036 * @bo: A pointer to a struct ttm_buffer_object.
1037 * @sync_obj: A sync object that signals when moving is complete.
1038 * @evict: This is an evict move. Don't return until the buffer is idle.
1039 * @no_wait_gpu: Return immediately if the GPU is busy.
1040 * @new_mem: struct ttm_mem_reg indicating where to move.
1042 * Accelerated move function to be called when an accelerated move
1043 * has been scheduled. The function will create a new temporary buffer object
1044 * representing the old placement, and put the sync object on both buffer
1045 * objects. After that the newly created buffer object is unref'd to be
1046 * destroyed when the move is complete. This will help pipeline
1050 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object
*bo
,
1052 bool evict
, bool no_wait_gpu
,
1053 struct ttm_mem_reg
*new_mem
);
1057 * @c_state: Caching state.
1058 * @tmp: Page protection flag for a normal, cached mapping.
1060 * Utility function that returns the pgprot_t that should be used for
1061 * setting up a PTE with the caching model indicated by @c_state.
1063 extern pgprot_t
ttm_io_prot(uint32_t caching_flags
, pgprot_t tmp
);
1065 extern const struct ttm_mem_type_manager_func ttm_bo_manager_func
;
1067 #if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
1069 #include <linux/agp_backend.h>
1074 * @bdev: Pointer to a struct ttm_bo_device.
1075 * @bridge: The agp bridge this device is sitting on.
1076 * @size: Size of the data needed backing.
1077 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
1078 * @dummy_read_page: See struct ttm_bo_device.
1081 * Create a TTM backend that uses the indicated AGP bridge as an aperture
1082 * for TT memory. This function uses the linux agpgart interface to
1083 * bind and unbind memory backing a ttm_tt.
1085 extern struct ttm_tt
*ttm_agp_tt_create(struct ttm_bo_device
*bdev
,
1086 struct agp_bridge_data
*bridge
,
1087 unsigned long size
, uint32_t page_flags
,
1088 struct page
*dummy_read_page
);
1089 int ttm_agp_tt_populate(struct ttm_tt
*ttm
);
1090 void ttm_agp_tt_unpopulate(struct ttm_tt
*ttm
);