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 <drm/drm_mm.h>
34 #include <drm/drm_vma_manager.h>
35 #include <linux/workqueue.h>
37 #include <linux/spinlock.h>
38 #include <linux/dma-resv.h>
40 #include "ttm_bo_api.h"
41 #include "ttm_memory.h"
42 #include "ttm_module.h"
43 #include "ttm_placement.h"
47 * struct ttm_bo_driver
49 * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
50 * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
51 * @move: Callback for a driver to hook in accelerated functions to
53 * If set to NULL, a potentially slow memcpy() move is used.
56 struct ttm_bo_driver
{
60 * @bo: The buffer object to create the ttm for.
61 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
63 * Create a struct ttm_tt to back data with system memory pages.
64 * No pages are actually allocated.
66 * NULL: Out of memory.
68 struct ttm_tt
*(*ttm_tt_create
)(struct ttm_buffer_object
*bo
,
74 * @ttm: The struct ttm_tt to contain the backing pages.
76 * Allocate all backing pages
78 * -ENOMEM: Out of memory.
80 int (*ttm_tt_populate
)(struct ttm_bo_device
*bdev
,
82 struct ttm_operation_ctx
*ctx
);
87 * @ttm: The struct ttm_tt to contain the backing pages.
89 * Free all backing page
91 void (*ttm_tt_unpopulate
)(struct ttm_bo_device
*bdev
, struct ttm_tt
*ttm
);
96 * @bdev: Pointer to a ttm device
97 * @ttm: Pointer to a struct ttm_tt.
99 * Destroy the backend. This will be call back from ttm_tt_destroy so
100 * don't call ttm_tt_destroy from the callback or infinite loop.
102 void (*ttm_tt_destroy
)(struct ttm_bo_device
*bdev
, struct ttm_tt
*ttm
);
105 * struct ttm_bo_driver member eviction_valuable
107 * @bo: the buffer object to be evicted
108 * @place: placement we need room for
110 * Check with the driver if it is valuable to evict a BO to make room
111 * for a certain placement.
113 bool (*eviction_valuable
)(struct ttm_buffer_object
*bo
,
114 const struct ttm_place
*place
);
116 * struct ttm_bo_driver member evict_flags:
118 * @bo: the buffer object to be evicted
120 * Return the bo flags for a buffer which is not mapped to the hardware.
121 * These will be placed in proposed_flags so that when the move is
122 * finished, they'll end up in bo->mem.flags
125 void (*evict_flags
)(struct ttm_buffer_object
*bo
,
126 struct ttm_placement
*placement
);
129 * struct ttm_bo_driver member move:
131 * @bo: the buffer to move
132 * @evict: whether this motion is evicting the buffer from
133 * the graphics address space
134 * @ctx: context for this move with parameters
135 * @new_mem: the new memory region receiving the buffer
137 * Move a buffer between two memory regions.
139 int (*move
)(struct ttm_buffer_object
*bo
, bool evict
,
140 struct ttm_operation_ctx
*ctx
,
141 struct ttm_resource
*new_mem
);
144 * struct ttm_bo_driver_member verify_access
146 * @bo: Pointer to a buffer object.
147 * @filp: Pointer to a struct file trying to access the object.
149 * Called from the map / write / read methods to verify that the
150 * caller is permitted to access the buffer object.
151 * This member may be set to NULL, which will refuse this kind of
152 * access for all buffer objects.
153 * This function should return 0 if access is granted, -EPERM otherwise.
155 int (*verify_access
)(struct ttm_buffer_object
*bo
,
159 * Hook to notify driver about a driver move so it
160 * can do tiling things and book-keeping.
162 * @evict: whether this move is evicting the buffer from the graphics
165 void (*move_notify
)(struct ttm_buffer_object
*bo
,
167 struct ttm_resource
*new_mem
);
170 * notify the driver that we're about to swap out this bo
172 void (*swap_notify
)(struct ttm_buffer_object
*bo
);
175 * Driver callback on when mapping io memory (for bo_move_memcpy
176 * for instance). TTM will take care to call io_mem_free whenever
177 * the mapping is not use anymore. io_mem_reserve & io_mem_free
180 int (*io_mem_reserve
)(struct ttm_bo_device
*bdev
,
181 struct ttm_resource
*mem
);
182 void (*io_mem_free
)(struct ttm_bo_device
*bdev
,
183 struct ttm_resource
*mem
);
186 * Return the pfn for a given page_offset inside the BO.
188 * @bo: the BO to look up the pfn for
189 * @page_offset: the offset to look up
191 unsigned long (*io_mem_pfn
)(struct ttm_buffer_object
*bo
,
192 unsigned long page_offset
);
195 * Read/write memory buffers for ptrace access
197 * @bo: the BO to access
198 * @offset: the offset from the start of the BO
199 * @buf: pointer to source/destination buffer
200 * @len: number of bytes to copy
201 * @write: whether to read (0) from or write (non-0) to BO
203 * If successful, this function should return the number of
204 * bytes copied, -EIO otherwise. If the number of bytes
205 * returned is < len, the function may be called again with
206 * the remainder of the buffer to copy.
208 int (*access_memory
)(struct ttm_buffer_object
*bo
, unsigned long offset
,
209 void *buf
, int len
, int write
);
212 * struct ttm_bo_driver member del_from_lru_notify
214 * @bo: the buffer object deleted from lru
216 * notify driver that a BO was deleted from LRU.
218 void (*del_from_lru_notify
)(struct ttm_buffer_object
*bo
);
221 * Notify the driver that we're about to release a BO
223 * @bo: BO that is about to be released
225 * Gives the driver a chance to do any cleanup, including
226 * adding fences that may force a delayed delete
228 void (*release_notify
)(struct ttm_buffer_object
*bo
);
232 * struct ttm_bo_global - Buffer object driver global data.
234 * @dummy_read_page: Pointer to a dummy page used for mapping requests
235 * of unpopulated pages.
236 * @shrink: A shrink callback object used for buffer object swap.
237 * @device_list_mutex: Mutex protecting the device list.
238 * This mutex is held while traversing the device list for pm options.
239 * @lru_lock: Spinlock protecting the bo subsystem lru lists.
240 * @device_list: List of buffer object devices.
241 * @swap_lru: Lru list of buffer objects used for swapping.
244 extern struct ttm_bo_global
{
247 * Constant after init.
251 struct page
*dummy_read_page
;
255 * Protected by ttm_global_mutex.
257 struct list_head device_list
;
260 * Protected by the lru_lock.
262 struct list_head swap_lru
[TTM_MAX_BO_PRIORITY
];
265 * Internal protection.
271 #define TTM_NUM_MEM_TYPES 8
274 * struct ttm_bo_device - Buffer object driver device-specific data.
276 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
277 * @man: An array of resource_managers.
278 * @vma_manager: Address space manager (pointer)
279 * lru_lock: Spinlock that protects the buffer+device lru lists and
281 * @dev_mapping: A pointer to the struct address_space representing the
282 * device address space.
283 * @wq: Work queue structure for the delayed delete workqueue.
284 * @no_retry: Don't retry allocation if it fails
288 struct ttm_bo_device
{
291 * Constant after bo device init / atomic.
293 struct list_head device_list
;
294 struct ttm_bo_driver
*driver
;
296 * access via ttm_manager_type.
298 struct ttm_resource_manager sysman
;
299 struct ttm_resource_manager
*man_drv
[TTM_NUM_MEM_TYPES
];
301 * Protected by internal locks.
303 struct drm_vma_offset_manager
*vma_manager
;
306 * Protected by the global:lru lock.
308 struct list_head ddestroy
;
311 * Protected by load / firstopen / lastclose /unload sync.
314 struct address_space
*dev_mapping
;
317 * Internal protection.
320 struct delayed_work wq
;
327 static inline struct ttm_resource_manager
*ttm_manager_type(struct ttm_bo_device
*bdev
,
330 return bdev
->man_drv
[mem_type
];
333 static inline void ttm_set_driver_manager(struct ttm_bo_device
*bdev
,
335 struct ttm_resource_manager
*manager
)
337 bdev
->man_drv
[type
] = manager
;
341 * struct ttm_lru_bulk_move_pos
343 * @first: first BO in the bulk move range
344 * @last: last BO in the bulk move range
346 * Positions for a lru bulk move.
348 struct ttm_lru_bulk_move_pos
{
349 struct ttm_buffer_object
*first
;
350 struct ttm_buffer_object
*last
;
354 * struct ttm_lru_bulk_move
356 * @tt: first/last lru entry for BOs in the TT domain
357 * @vram: first/last lru entry for BOs in the VRAM domain
358 * @swap: first/last lru entry for BOs on the swap list
360 * Helper structure for bulk moves on the LRU list.
362 struct ttm_lru_bulk_move
{
363 struct ttm_lru_bulk_move_pos tt
[TTM_MAX_BO_PRIORITY
];
364 struct ttm_lru_bulk_move_pos vram
[TTM_MAX_BO_PRIORITY
];
365 struct ttm_lru_bulk_move_pos swap
[TTM_MAX_BO_PRIORITY
];
375 * @bo: Pointer to a struct ttm_buffer_object. the data of which
376 * we want to allocate space for.
377 * @proposed_placement: Proposed new placement for the buffer object.
378 * @mem: A struct ttm_resource.
379 * @interruptible: Sleep interruptible when sliping.
380 * @no_wait_gpu: Return immediately if the GPU is busy.
382 * Allocate memory space for the buffer object pointed to by @bo, using
383 * the placement flags in @mem, potentially evicting other idle buffer objects.
384 * This function may sleep while waiting for space to become available.
386 * -EBUSY: No space available (only if no_wait == 1).
387 * -ENOMEM: Could not allocate memory for the buffer object, either due to
388 * fragmentation or concurrent allocators.
389 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
391 int ttm_bo_mem_space(struct ttm_buffer_object
*bo
,
392 struct ttm_placement
*placement
,
393 struct ttm_resource
*mem
,
394 struct ttm_operation_ctx
*ctx
);
396 int ttm_bo_device_release(struct ttm_bo_device
*bdev
);
401 * @bdev: A pointer to a struct ttm_bo_device to initialize.
402 * @glob: A pointer to an initialized struct ttm_bo_global.
403 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
404 * @mapping: The address space to use for this bo.
405 * @vma_manager: A pointer to a vma manager.
406 * @file_page_offset: Offset into the device address space that is available
407 * for buffer data. This ensures compatibility with other users of the
410 * Initializes a struct ttm_bo_device:
414 int ttm_bo_device_init(struct ttm_bo_device
*bdev
,
415 struct ttm_bo_driver
*driver
,
416 struct address_space
*mapping
,
417 struct drm_vma_offset_manager
*vma_manager
,
421 * ttm_bo_unmap_virtual
423 * @bo: tear down the virtual mappings for this BO
425 void ttm_bo_unmap_virtual(struct ttm_buffer_object
*bo
);
430 * @bo: A pointer to a struct ttm_buffer_object.
431 * @interruptible: Sleep interruptible if waiting.
432 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
433 * @ticket: ticket used to acquire the ww_mutex.
435 * Locks a buffer object for validation. (Or prevents other processes from
436 * locking it for validation), while taking a number of measures to prevent
440 * -EDEADLK: The reservation may cause a deadlock.
441 * Release all buffer reservations, wait for @bo to become unreserved and
443 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
444 * a signal. Release all buffer reservations and return to user-space.
445 * -EBUSY: The function needed to sleep, but @no_wait was true
446 * -EALREADY: Bo already reserved using @ticket. This error code will only
447 * be returned if @use_ticket is set to true.
449 static inline int ttm_bo_reserve(struct ttm_buffer_object
*bo
,
450 bool interruptible
, bool no_wait
,
451 struct ww_acquire_ctx
*ticket
)
460 success
= dma_resv_trylock(bo
->base
.resv
);
461 return success
? 0 : -EBUSY
;
465 ret
= dma_resv_lock_interruptible(bo
->base
.resv
, ticket
);
467 ret
= dma_resv_lock(bo
->base
.resv
, ticket
);
474 * ttm_bo_reserve_slowpath:
475 * @bo: A pointer to a struct ttm_buffer_object.
476 * @interruptible: Sleep interruptible if waiting.
477 * @sequence: Set (@bo)->sequence to this value after lock
479 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
480 * from all our other reservations. Because there are no other reservations
481 * held by us, this function cannot deadlock any more.
483 static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object
*bo
,
485 struct ww_acquire_ctx
*ticket
)
488 int ret
= dma_resv_lock_slow_interruptible(bo
->base
.resv
,
494 dma_resv_lock_slow(bo
->base
.resv
, ticket
);
498 static inline void ttm_bo_move_to_lru_tail_unlocked(struct ttm_buffer_object
*bo
)
500 spin_lock(&ttm_bo_glob
.lru_lock
);
501 ttm_bo_move_to_lru_tail(bo
, NULL
);
502 spin_unlock(&ttm_bo_glob
.lru_lock
);
505 static inline void ttm_bo_assign_mem(struct ttm_buffer_object
*bo
,
506 struct ttm_resource
*new_mem
)
509 new_mem
->mm_node
= NULL
;
513 * ttm_bo_move_null = assign memory for a buffer object.
514 * @bo: The bo to assign the memory to
515 * @new_mem: The memory to be assigned.
517 * Assign the memory from new_mem to the memory of the buffer object bo.
519 static inline void ttm_bo_move_null(struct ttm_buffer_object
*bo
,
520 struct ttm_resource
*new_mem
)
522 struct ttm_resource
*old_mem
= &bo
->mem
;
524 WARN_ON(old_mem
->mm_node
!= NULL
);
525 ttm_bo_assign_mem(bo
, new_mem
);
531 * @bo: A pointer to a struct ttm_buffer_object.
533 * Unreserve a previous reservation of @bo.
535 static inline void ttm_bo_unreserve(struct ttm_buffer_object
*bo
)
537 ttm_bo_move_to_lru_tail_unlocked(bo
);
538 dma_resv_unlock(bo
->base
.resv
);
544 int ttm_mem_io_reserve(struct ttm_bo_device
*bdev
,
545 struct ttm_resource
*mem
);
546 void ttm_mem_io_free(struct ttm_bo_device
*bdev
,
547 struct ttm_resource
*mem
);
552 * @bo: A pointer to a struct ttm_buffer_object.
553 * @interruptible: Sleep interruptible if waiting.
554 * @no_wait_gpu: Return immediately if the GPU is busy.
555 * @new_mem: struct ttm_resource indicating where to move.
557 * Fallback move function for a mappable buffer object in mappable memory.
558 * The function will, if successful,
559 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
560 * and update the (@bo)->mem placement flags. If unsuccessful, the old
561 * data remains untouched, and it's up to the caller to free the
562 * memory space indicated by @new_mem.
567 int ttm_bo_move_memcpy(struct ttm_buffer_object
*bo
,
568 struct ttm_operation_ctx
*ctx
,
569 struct ttm_resource
*new_mem
);
572 * ttm_bo_move_accel_cleanup.
574 * @bo: A pointer to a struct ttm_buffer_object.
575 * @fence: A fence object that signals when moving is complete.
576 * @evict: This is an evict move. Don't return until the buffer is idle.
577 * @pipeline: evictions are to be pipelined.
578 * @new_mem: struct ttm_resource indicating where to move.
580 * Accelerated move function to be called when an accelerated move
581 * has been scheduled. The function will create a new temporary buffer object
582 * representing the old placement, and put the sync object on both buffer
583 * objects. After that the newly created buffer object is unref'd to be
584 * destroyed when the move is complete. This will help pipeline
587 int ttm_bo_move_accel_cleanup(struct ttm_buffer_object
*bo
,
588 struct dma_fence
*fence
, bool evict
,
590 struct ttm_resource
*new_mem
);
593 * ttm_bo_pipeline_gutting.
595 * @bo: A pointer to a struct ttm_buffer_object.
597 * Pipelined gutting a BO of its backing store.
599 int ttm_bo_pipeline_gutting(struct ttm_buffer_object
*bo
);
604 * bo: ttm buffer object
605 * res: ttm resource object
606 * @tmp: Page protection flag for a normal, cached mapping.
608 * Utility function that returns the pgprot_t that should be used for
609 * setting up a PTE with the caching model indicated by @c_state.
611 pgprot_t
ttm_io_prot(struct ttm_buffer_object
*bo
, struct ttm_resource
*res
,
617 * Bind the object tt to a memory resource.
619 int ttm_bo_tt_bind(struct ttm_buffer_object
*bo
, struct ttm_resource
*mem
);
624 void ttm_bo_tt_destroy(struct ttm_buffer_object
*bo
);
630 * @type: memory manager type
631 * @use_tt: if the memory manager uses tt
632 * @p_size: size of area to be managed in pages.
634 * Initialise a generic range manager for the selected memory type.
635 * The range manager is installed for this device in the type slot.
637 int ttm_range_man_init(struct ttm_bo_device
*bdev
,
638 unsigned type
, bool use_tt
,
639 unsigned long p_size
);
645 * @type: memory manager type
647 * Remove the generic range manager from a slot and tear it down.
649 int ttm_range_man_fini(struct ttm_bo_device
*bdev
,