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.
98 * @bo_mem: Pointer to a struct ttm_resource describing the
99 * memory type and location for binding.
101 * Bind the backend pages into the aperture in the location
102 * indicated by @bo_mem. This function should be able to handle
103 * differences between aperture and system page sizes.
105 int (*ttm_tt_bind)(struct ttm_bo_device *bdev, struct ttm_tt *ttm, struct ttm_resource *bo_mem);
110 * @bdev: Pointer to a ttm device
111 * @ttm: Pointer to a struct ttm_tt.
113 * Unbind previously bound backend pages. This function should be
114 * able to handle differences between aperture and system page sizes.
116 void (*ttm_tt_unbind)(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
121 * @bdev: Pointer to a ttm device
122 * @ttm: Pointer to a struct ttm_tt.
124 * Destroy the backend. This will be call back from ttm_tt_destroy so
125 * don't call ttm_tt_destroy from the callback or infinite loop.
127 void (*ttm_tt_destroy)(struct ttm_bo_device *bdev, struct ttm_tt *ttm);
130 * struct ttm_bo_driver member eviction_valuable
132 * @bo: the buffer object to be evicted
133 * @place: placement we need room for
135 * Check with the driver if it is valuable to evict a BO to make room
136 * for a certain placement.
138 bool (*eviction_valuable)(struct ttm_buffer_object *bo,
139 const struct ttm_place *place);
141 * struct ttm_bo_driver member evict_flags:
143 * @bo: the buffer object to be evicted
145 * Return the bo flags for a buffer which is not mapped to the hardware.
146 * These will be placed in proposed_flags so that when the move is
147 * finished, they'll end up in bo->mem.flags
150 void (*evict_flags)(struct ttm_buffer_object *bo,
151 struct ttm_placement *placement);
154 * struct ttm_bo_driver member move:
156 * @bo: the buffer to move
157 * @evict: whether this motion is evicting the buffer from
158 * the graphics address space
159 * @ctx: context for this move with parameters
160 * @new_mem: the new memory region receiving the buffer
162 * Move a buffer between two memory regions.
164 int (*move)(struct ttm_buffer_object *bo, bool evict,
165 struct ttm_operation_ctx *ctx,
166 struct ttm_resource *new_mem);
169 * struct ttm_bo_driver_member verify_access
171 * @bo: Pointer to a buffer object.
172 * @filp: Pointer to a struct file trying to access the object.
174 * Called from the map / write / read methods to verify that the
175 * caller is permitted to access the buffer object.
176 * This member may be set to NULL, which will refuse this kind of
177 * access for all buffer objects.
178 * This function should return 0 if access is granted, -EPERM otherwise.
180 int (*verify_access)(struct ttm_buffer_object *bo,
184 * Hook to notify driver about a driver move so it
185 * can do tiling things and book-keeping.
187 * @evict: whether this move is evicting the buffer from the graphics
190 void (*move_notify)(struct ttm_buffer_object *bo,
192 struct ttm_resource *new_mem);
193 /* notify the driver we are taking a fault on this BO
194 * and have reserved it */
195 int (*fault_reserve_notify)(struct ttm_buffer_object *bo);
198 * notify the driver that we're about to swap out this bo
200 void (*swap_notify)(struct ttm_buffer_object *bo);
203 * Driver callback on when mapping io memory (for bo_move_memcpy
204 * for instance). TTM will take care to call io_mem_free whenever
205 * the mapping is not use anymore. io_mem_reserve & io_mem_free
208 int (*io_mem_reserve)(struct ttm_bo_device *bdev,
209 struct ttm_resource *mem);
210 void (*io_mem_free)(struct ttm_bo_device *bdev,
211 struct ttm_resource *mem);
214 * Return the pfn for a given page_offset inside the BO.
216 * @bo: the BO to look up the pfn for
217 * @page_offset: the offset to look up
219 unsigned long (*io_mem_pfn)(struct ttm_buffer_object *bo,
220 unsigned long page_offset);
223 * Read/write memory buffers for ptrace access
225 * @bo: the BO to access
226 * @offset: the offset from the start of the BO
227 * @buf: pointer to source/destination buffer
228 * @len: number of bytes to copy
229 * @write: whether to read (0) from or write (non-0) to BO
231 * If successful, this function should return the number of
232 * bytes copied, -EIO otherwise. If the number of bytes
233 * returned is < len, the function may be called again with
234 * the remainder of the buffer to copy.
236 int (*access_memory)(struct ttm_buffer_object *bo, unsigned long offset,
237 void *buf, int len, int write);
240 * struct ttm_bo_driver member del_from_lru_notify
242 * @bo: the buffer object deleted from lru
244 * notify driver that a BO was deleted from LRU.
246 void (*del_from_lru_notify)(struct ttm_buffer_object *bo);
249 * Notify the driver that we're about to release a BO
251 * @bo: BO that is about to be released
253 * Gives the driver a chance to do any cleanup, including
254 * adding fences that may force a delayed delete
256 void (*release_notify)(struct ttm_buffer_object *bo);
260 * struct ttm_bo_global - Buffer object driver global data.
262 * @dummy_read_page: Pointer to a dummy page used for mapping requests
263 * of unpopulated pages.
264 * @shrink: A shrink callback object used for buffer object swap.
265 * @device_list_mutex: Mutex protecting the device list.
266 * This mutex is held while traversing the device list for pm options.
267 * @lru_lock: Spinlock protecting the bo subsystem lru lists.
268 * @device_list: List of buffer object devices.
269 * @swap_lru: Lru list of buffer objects used for swapping.
272 extern struct ttm_bo_global {
275 * Constant after init.
279 struct page *dummy_read_page;
283 * Protected by ttm_global_mutex.
285 struct list_head device_list;
288 * Protected by the lru_lock.
290 struct list_head swap_lru[TTM_MAX_BO_PRIORITY];
293 * Internal protection.
299 #define TTM_NUM_MEM_TYPES 8
302 * struct ttm_bo_device - Buffer object driver device-specific data.
304 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
305 * @man: An array of resource_managers.
306 * @vma_manager: Address space manager (pointer)
307 * lru_lock: Spinlock that protects the buffer+device lru lists and
309 * @dev_mapping: A pointer to the struct address_space representing the
310 * device address space.
311 * @wq: Work queue structure for the delayed delete workqueue.
312 * @no_retry: Don't retry allocation if it fails
316 struct ttm_bo_device {
319 * Constant after bo device init / atomic.
321 struct list_head device_list;
322 struct ttm_bo_driver *driver;
324 * access via ttm_manager_type.
326 struct ttm_resource_manager sysman;
327 struct ttm_resource_manager *man_drv[TTM_NUM_MEM_TYPES];
329 * Protected by internal locks.
331 struct drm_vma_offset_manager *vma_manager;
334 * Protected by the global:lru lock.
336 struct list_head ddestroy;
339 * Protected by load / firstopen / lastclose /unload sync.
342 struct address_space *dev_mapping;
345 * Internal protection.
348 struct delayed_work wq;
355 static inline struct ttm_resource_manager *ttm_manager_type(struct ttm_bo_device *bdev,
358 return bdev->man_drv[mem_type];
361 static inline void ttm_set_driver_manager(struct ttm_bo_device *bdev,
363 struct ttm_resource_manager *manager)
365 bdev->man_drv[type] = manager;
369 * struct ttm_lru_bulk_move_pos
371 * @first: first BO in the bulk move range
372 * @last: last BO in the bulk move range
374 * Positions for a lru bulk move.
376 struct ttm_lru_bulk_move_pos {
377 struct ttm_buffer_object *first;
378 struct ttm_buffer_object *last;
382 * struct ttm_lru_bulk_move
384 * @tt: first/last lru entry for BOs in the TT domain
385 * @vram: first/last lru entry for BOs in the VRAM domain
386 * @swap: first/last lru entry for BOs on the swap list
388 * Helper structure for bulk moves on the LRU list.
390 struct ttm_lru_bulk_move {
391 struct ttm_lru_bulk_move_pos tt[TTM_MAX_BO_PRIORITY];
392 struct ttm_lru_bulk_move_pos vram[TTM_MAX_BO_PRIORITY];
393 struct ttm_lru_bulk_move_pos swap[TTM_MAX_BO_PRIORITY];
403 * @bo: Pointer to a struct ttm_buffer_object. the data of which
404 * we want to allocate space for.
405 * @proposed_placement: Proposed new placement for the buffer object.
406 * @mem: A struct ttm_resource.
407 * @interruptible: Sleep interruptible when sliping.
408 * @no_wait_gpu: Return immediately if the GPU is busy.
410 * Allocate memory space for the buffer object pointed to by @bo, using
411 * the placement flags in @mem, potentially evicting other idle buffer objects.
412 * This function may sleep while waiting for space to become available.
414 * -EBUSY: No space available (only if no_wait == 1).
415 * -ENOMEM: Could not allocate memory for the buffer object, either due to
416 * fragmentation or concurrent allocators.
417 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
419 int ttm_bo_mem_space(struct ttm_buffer_object *bo,
420 struct ttm_placement *placement,
421 struct ttm_resource *mem,
422 struct ttm_operation_ctx *ctx);
424 int ttm_bo_device_release(struct ttm_bo_device *bdev);
429 * @bdev: A pointer to a struct ttm_bo_device to initialize.
430 * @glob: A pointer to an initialized struct ttm_bo_global.
431 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
432 * @mapping: The address space to use for this bo.
433 * @vma_manager: A pointer to a vma manager.
434 * @file_page_offset: Offset into the device address space that is available
435 * for buffer data. This ensures compatibility with other users of the
438 * Initializes a struct ttm_bo_device:
442 int ttm_bo_device_init(struct ttm_bo_device *bdev,
443 struct ttm_bo_driver *driver,
444 struct address_space *mapping,
445 struct drm_vma_offset_manager *vma_manager,
449 * ttm_bo_unmap_virtual
451 * @bo: tear down the virtual mappings for this BO
453 void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
456 * ttm_bo_unmap_virtual
458 * @bo: tear down the virtual mappings for this BO
460 * The caller must take ttm_mem_io_lock before calling this function.
462 void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo);
467 * @bo: A pointer to a struct ttm_buffer_object.
468 * @interruptible: Sleep interruptible if waiting.
469 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
470 * @ticket: ticket used to acquire the ww_mutex.
472 * Locks a buffer object for validation. (Or prevents other processes from
473 * locking it for validation), while taking a number of measures to prevent
477 * -EDEADLK: The reservation may cause a deadlock.
478 * Release all buffer reservations, wait for @bo to become unreserved and
480 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
481 * a signal. Release all buffer reservations and return to user-space.
482 * -EBUSY: The function needed to sleep, but @no_wait was true
483 * -EALREADY: Bo already reserved using @ticket. This error code will only
484 * be returned if @use_ticket is set to true.
486 static inline int ttm_bo_reserve(struct ttm_buffer_object *bo,
487 bool interruptible, bool no_wait,
488 struct ww_acquire_ctx *ticket)
497 success = dma_resv_trylock(bo->base.resv);
498 return success ? 0 : -EBUSY;
502 ret = dma_resv_lock_interruptible(bo->base.resv, ticket);
504 ret = dma_resv_lock(bo->base.resv, ticket);
511 * ttm_bo_reserve_slowpath:
512 * @bo: A pointer to a struct ttm_buffer_object.
513 * @interruptible: Sleep interruptible if waiting.
514 * @sequence: Set (@bo)->sequence to this value after lock
516 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
517 * from all our other reservations. Because there are no other reservations
518 * held by us, this function cannot deadlock any more.
520 static inline int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo,
522 struct ww_acquire_ctx *ticket)
525 int ret = dma_resv_lock_slow_interruptible(bo->base.resv,
531 dma_resv_lock_slow(bo->base.resv, ticket);
535 static inline void ttm_bo_move_to_lru_tail_unlocked(struct ttm_buffer_object *bo)
537 spin_lock(&ttm_bo_glob.lru_lock);
538 ttm_bo_move_to_lru_tail(bo, NULL);
539 spin_unlock(&ttm_bo_glob.lru_lock);
543 * ttm_bo_move_null = assign memory for a buffer object.
544 * @bo: The bo to assign the memory to
545 * @new_mem: The memory to be assigned.
547 * Assign the memory from new_mem to the memory of the buffer object bo.
549 static inline void ttm_bo_move_null(struct ttm_buffer_object *bo,
550 struct ttm_resource *new_mem)
552 struct ttm_resource *old_mem = &bo->mem;
554 WARN_ON(old_mem->mm_node != NULL);
556 new_mem->mm_node = NULL;
562 * @bo: A pointer to a struct ttm_buffer_object.
564 * Unreserve a previous reservation of @bo.
566 static inline void ttm_bo_unreserve(struct ttm_buffer_object *bo)
568 ttm_bo_move_to_lru_tail_unlocked(bo);
569 dma_resv_unlock(bo->base.resv);
576 int ttm_mem_io_reserve(struct ttm_bo_device *bdev,
577 struct ttm_resource *mem);
578 void ttm_mem_io_free(struct ttm_bo_device *bdev,
579 struct ttm_resource *mem);
583 * @bo: A pointer to a struct ttm_buffer_object.
584 * @interruptible: Sleep interruptible if waiting.
585 * @no_wait_gpu: Return immediately if the GPU is busy.
586 * @new_mem: struct ttm_resource indicating where to move.
588 * Optimized move function for a buffer object with both old and
589 * new placement backed by a TTM. The function will, if successful,
590 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
591 * and update the (@bo)->mem placement flags. If unsuccessful, the old
592 * data remains untouched, and it's up to the caller to free the
593 * memory space indicated by @new_mem.
598 int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
599 struct ttm_operation_ctx *ctx,
600 struct ttm_resource *new_mem);
605 * @bo: A pointer to a struct ttm_buffer_object.
606 * @interruptible: Sleep interruptible if waiting.
607 * @no_wait_gpu: Return immediately if the GPU is busy.
608 * @new_mem: struct ttm_resource indicating where to move.
610 * Fallback move function for a mappable buffer object in mappable memory.
611 * The function will, if successful,
612 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
613 * and update the (@bo)->mem placement flags. If unsuccessful, the old
614 * data remains untouched, and it's up to the caller to free the
615 * memory space indicated by @new_mem.
620 int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
621 struct ttm_operation_ctx *ctx,
622 struct ttm_resource *new_mem);
625 * ttm_bo_free_old_node
627 * @bo: A pointer to a struct ttm_buffer_object.
629 * Utility function to free an old placement after a successful move.
631 void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
634 * ttm_bo_move_accel_cleanup.
636 * @bo: A pointer to a struct ttm_buffer_object.
637 * @fence: A fence object that signals when moving is complete.
638 * @evict: This is an evict move. Don't return until the buffer is idle.
639 * @new_mem: struct ttm_resource indicating where to move.
641 * Accelerated move function to be called when an accelerated move
642 * has been scheduled. The function will create a new temporary buffer object
643 * representing the old placement, and put the sync object on both buffer
644 * objects. After that the newly created buffer object is unref'd to be
645 * destroyed when the move is complete. This will help pipeline
648 int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
649 struct dma_fence *fence, bool evict,
650 struct ttm_resource *new_mem);
653 * ttm_bo_pipeline_move.
655 * @bo: A pointer to a struct ttm_buffer_object.
656 * @fence: A fence object that signals when moving is complete.
657 * @evict: This is an evict move. Don't return until the buffer is idle.
658 * @new_mem: struct ttm_resource indicating where to move.
660 * Function for pipelining accelerated moves. Either free the memory
661 * immediately or hang it on a temporary buffer object.
663 int ttm_bo_pipeline_move(struct ttm_buffer_object *bo,
664 struct dma_fence *fence, bool evict,
665 struct ttm_resource *new_mem);
668 * ttm_bo_pipeline_gutting.
670 * @bo: A pointer to a struct ttm_buffer_object.
672 * Pipelined gutting a BO of its backing store.
674 int ttm_bo_pipeline_gutting(struct ttm_buffer_object *bo);
679 * @c_state: Caching state.
680 * @tmp: Page protection flag for a normal, cached mapping.
682 * Utility function that returns the pgprot_t that should be used for
683 * setting up a PTE with the caching model indicated by @c_state.
685 pgprot_t ttm_io_prot(uint32_t caching_flags, pgprot_t tmp);
691 * @type: memory manager type
692 * @available_caching: TTM_PL_FLAG_* for allowed caching modes
693 * @use_tt: if the memory manager uses tt
694 * @p_size: size of area to be managed in pages.
696 * Initialise a generic range manager for the selected memory type.
697 * The range manager is installed for this device in the type slot.
699 int ttm_range_man_init(struct ttm_bo_device *bdev,
701 uint32_t available_caching,
703 unsigned long p_size);
709 * @type: memory manager type
711 * Remove the generic range manager from a slot and tear it down.
713 int ttm_range_man_fini(struct ttm_bo_device *bdev,