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 /* $FreeBSD: head/sys/dev/drm2/ttm/ttm_bo_driver.h 247835 2013-03-05 09:49:34Z kib $ */
31 #ifndef _TTM_BO_DRIVER_H_
32 #define _TTM_BO_DRIVER_H_
34 #include <drm/ttm/ttm_bo_api.h>
35 #include <drm/ttm/ttm_memory.h>
36 #include <drm/ttm/ttm_module.h>
37 #include <drm/drm_mm.h>
38 #include <drm/drm_global.h>
40 #include <linux/workqueue.h>
42 struct ttm_backend_func {
44 * struct ttm_backend_func member bind
46 * @ttm: Pointer to a struct ttm_tt.
47 * @bo_mem: Pointer to a struct ttm_mem_reg describing the
48 * memory type and location for binding.
50 * Bind the backend pages into the aperture in the location
51 * indicated by @bo_mem. This function should be able to handle
52 * differences between aperture and system page sizes.
54 int (*bind) (struct ttm_tt *ttm, struct ttm_mem_reg *bo_mem);
57 * struct ttm_backend_func member unbind
59 * @ttm: Pointer to a struct ttm_tt.
61 * Unbind previously bound backend pages. This function should be
62 * able to handle differences between aperture and system page sizes.
64 int (*unbind) (struct ttm_tt *ttm);
67 * struct ttm_backend_func member destroy
69 * @ttm: Pointer to a struct ttm_tt.
71 * Destroy the backend. This will be call back from ttm_tt_destroy so
72 * don't call ttm_tt_destroy from the callback or infinite loop.
74 void (*destroy) (struct ttm_tt *ttm);
77 #define TTM_PAGE_FLAG_WRITE (1 << 3)
78 #define TTM_PAGE_FLAG_SWAPPED (1 << 4)
79 #define TTM_PAGE_FLAG_PERSISTENT_SWAP (1 << 5)
80 #define TTM_PAGE_FLAG_ZERO_ALLOC (1 << 6)
81 #define TTM_PAGE_FLAG_DMA32 (1 << 7)
82 #define TTM_PAGE_FLAG_SG (1 << 8)
84 enum ttm_caching_state {
93 * @bdev: Pointer to a struct ttm_bo_device.
94 * @func: Pointer to a struct ttm_backend_func that describes
95 * the backend methods.
96 * @dummy_read_page: Page to map where the ttm_tt page array contains a NULL
98 * @pages: Array of pages backing the data.
99 * @num_pages: Number of pages in the page array.
100 * @bdev: Pointer to the current struct ttm_bo_device.
101 * @be: Pointer to the ttm backend.
102 * @swap_storage: Pointer to shmem struct file for swap storage.
103 * @caching_state: The current caching state of the pages.
104 * @state: The current binding state of the pages.
106 * This is a structure holding the pages, caching- and aperture binding
107 * status for a buffer object that isn't backed by fixed (VRAM / AGP)
112 struct ttm_bo_device *bdev;
113 struct ttm_backend_func *func;
114 struct vm_page *dummy_read_page;
115 struct vm_page **pages;
117 unsigned long num_pages;
118 struct sg_table *sg; /* for SG objects via dma-buf */
119 struct ttm_bo_global *glob;
120 struct vm_object *swap_storage;
121 enum ttm_caching_state caching_state;
132 * @ttm: Base ttm_tt struct.
133 * @dma_address: The DMA (bus) addresses of the pages
134 * @pages_list: used by some page allocation backend
136 * This is a structure holding the pages, caching- and aperture binding
137 * status for a buffer object that isn't backed by fixed (VRAM / AGP)
142 dma_addr_t *dma_address;
143 struct list_head pages_list;
146 #define TTM_MEMTYPE_FLAG_FIXED (1 << 0) /* Fixed (on-card) PCI memory */
147 #define TTM_MEMTYPE_FLAG_MAPPABLE (1 << 1) /* Memory mappable */
148 #define TTM_MEMTYPE_FLAG_CMA (1 << 3) /* Can't map aperture */
150 struct ttm_mem_type_manager;
152 struct ttm_mem_type_manager_func {
154 * struct ttm_mem_type_manager member init
156 * @man: Pointer to a memory type manager.
157 * @p_size: Implementation dependent, but typically the size of the
158 * range to be managed in pages.
160 * Called to initialize a private range manager. The function is
161 * expected to initialize the man::priv member.
162 * Returns 0 on success, negative error code on failure.
164 int (*init)(struct ttm_mem_type_manager *man, unsigned long p_size);
167 * struct ttm_mem_type_manager member takedown
169 * @man: Pointer to a memory type manager.
171 * Called to undo the setup done in init. All allocated resources
174 int (*takedown)(struct ttm_mem_type_manager *man);
177 * struct ttm_mem_type_manager member get_node
179 * @man: Pointer to a memory type manager.
180 * @bo: Pointer to the buffer object we're allocating space for.
181 * @placement: Placement details.
182 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
184 * This function should allocate space in the memory type managed
185 * by @man. Placement details if
186 * applicable are given by @placement. If successful,
187 * @mem::mm_node should be set to a non-null value, and
188 * @mem::start should be set to a value identifying the beginning
189 * of the range allocated, and the function should return zero.
190 * If the memory region accommodate the buffer object, @mem::mm_node
191 * should be set to NULL, and the function should return 0.
192 * If a system error occurred, preventing the request to be fulfilled,
193 * the function should return a negative error code.
195 * Note that @mem::mm_node will only be dereferenced by
196 * struct ttm_mem_type_manager functions and optionally by the driver,
197 * which has knowledge of the underlying type.
199 * This function may not be called from within atomic context, so
200 * an implementation can and must use either a mutex or a spinlock to
201 * protect any data structures managing the space.
203 int (*get_node)(struct ttm_mem_type_manager *man,
204 struct ttm_buffer_object *bo,
205 struct ttm_placement *placement,
206 struct ttm_mem_reg *mem);
209 * struct ttm_mem_type_manager member put_node
211 * @man: Pointer to a memory type manager.
212 * @mem: Pointer to a struct ttm_mem_reg to be filled in.
214 * This function frees memory type resources previously allocated
215 * and that are identified by @mem::mm_node and @mem::start. May not
216 * be called from within atomic context.
218 void (*put_node)(struct ttm_mem_type_manager *man,
219 struct ttm_mem_reg *mem);
222 * struct ttm_mem_type_manager member debug
224 * @man: Pointer to a memory type manager.
225 * @prefix: Prefix to be used in printout to identify the caller.
227 * This function is called to print out the state of the memory
228 * type manager to aid debugging of out-of-memory conditions.
229 * It may not be called from within atomic context.
231 void (*debug)(struct ttm_mem_type_manager *man, const char *prefix);
235 * struct ttm_mem_type_manager
237 * @has_type: The memory type has been initialized.
238 * @use_type: The memory type is enabled.
239 * @flags: TTM_MEMTYPE_XX flags identifying the traits of the memory
240 * managed by this memory type.
241 * @gpu_offset: If used, the GPU offset of the first managed page of
242 * fixed memory or the first managed location in an aperture.
243 * @size: Size of the managed region.
244 * @available_caching: A mask of available caching types, TTM_PL_FLAG_XX,
245 * as defined in ttm_placement_common.h
246 * @default_caching: The default caching policy used for a buffer object
247 * placed in this memory type if the user doesn't provide one.
248 * @func: structure pointer implementing the range manager. See above
249 * @priv: Driver private closure for @func.
250 * @io_reserve_mutex: Mutex optionally protecting shared io_reserve structures
251 * @use_io_reserve_lru: Use an lru list to try to unreserve io_mem_regions
252 * reserved by the TTM vm system.
253 * @io_reserve_lru: Optional lru list for unreserving io mem regions.
254 * @io_reserve_fastpath: Only use bdev::driver::io_mem_reserve to obtain
255 * static information. bdev::driver::io_mem_free is never used.
256 * @lru: The lru list for this memory type.
258 * This structure is used to identify and manage memory types for a device.
259 * It's set up by the ttm_bo_driver::init_mem_type method.
264 struct ttm_mem_type_manager {
265 struct ttm_bo_device *bdev;
268 * No protection. Constant from start.
274 unsigned long gpu_offset;
276 uint32_t available_caching;
277 uint32_t default_caching;
278 const struct ttm_mem_type_manager_func *func;
280 struct lock io_reserve_mutex;
281 bool use_io_reserve_lru;
282 bool io_reserve_fastpath;
285 * Protected by @io_reserve_mutex:
288 struct list_head io_reserve_lru;
291 * Protected by the global->lru_lock.
294 struct list_head lru;
298 * struct ttm_bo_driver
300 * @create_ttm_backend_entry: Callback to create a struct ttm_backend.
301 * @invalidate_caches: Callback to invalidate read caches when a buffer object
303 * @init_mem_type: Callback to initialize a struct ttm_mem_type_manager
305 * @evict_flags: Callback to obtain placement flags when a buffer is evicted.
306 * @move: Callback for a driver to hook in accelerated functions to
308 * If set to NULL, a potentially slow memcpy() move is used.
309 * @sync_obj_signaled: See ttm_fence_api.h
310 * @sync_obj_wait: See ttm_fence_api.h
311 * @sync_obj_flush: See ttm_fence_api.h
312 * @sync_obj_unref: See ttm_fence_api.h
313 * @sync_obj_ref: See ttm_fence_api.h
316 struct ttm_bo_driver {
320 * @bdev: pointer to a struct ttm_bo_device:
321 * @size: Size of the data needed backing.
322 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
323 * @dummy_read_page: See struct ttm_bo_device.
325 * Create a struct ttm_tt to back data with system memory pages.
326 * No pages are actually allocated.
328 * NULL: Out of memory.
330 struct ttm_tt *(*ttm_tt_create)(struct ttm_bo_device *bdev,
333 struct vm_page *dummy_read_page);
338 * @ttm: The struct ttm_tt to contain the backing pages.
340 * Allocate all backing pages
342 * -ENOMEM: Out of memory.
344 int (*ttm_tt_populate)(struct ttm_tt *ttm);
349 * @ttm: The struct ttm_tt to contain the backing pages.
351 * Free all backing page
353 void (*ttm_tt_unpopulate)(struct ttm_tt *ttm);
356 * struct ttm_bo_driver member invalidate_caches
358 * @bdev: the buffer object device.
359 * @flags: new placement of the rebound buffer object.
361 * A previosly evicted buffer has been rebound in a
362 * potentially new location. Tell the driver that it might
363 * consider invalidating read (texture) caches on the next command
364 * submission as a consequence.
367 int (*invalidate_caches) (struct ttm_bo_device *bdev, uint32_t flags);
368 int (*init_mem_type) (struct ttm_bo_device *bdev, uint32_t type,
369 struct ttm_mem_type_manager *man);
371 * struct ttm_bo_driver member evict_flags:
373 * @bo: the buffer object to be evicted
375 * Return the bo flags for a buffer which is not mapped to the hardware.
376 * These will be placed in proposed_flags so that when the move is
377 * finished, they'll end up in bo->mem.flags
380 void(*evict_flags) (struct ttm_buffer_object *bo,
381 struct ttm_placement *placement);
383 * struct ttm_bo_driver member move:
385 * @bo: the buffer to move
386 * @evict: whether this motion is evicting the buffer from
387 * the graphics address space
388 * @interruptible: Use interruptible sleeps if possible when sleeping.
389 * @no_wait: whether this should give up and return -EBUSY
390 * if this move would require sleeping
391 * @new_mem: the new memory region receiving the buffer
393 * Move a buffer between two memory regions.
395 int (*move) (struct ttm_buffer_object *bo,
396 bool evict, bool interruptible,
398 struct ttm_mem_reg *new_mem);
401 * struct ttm_bo_driver_member verify_access
403 * @bo: Pointer to a buffer object.
404 * @filp: Pointer to a struct file trying to access the object.
405 * FreeBSD: use devfs_get_cdevpriv etc.
407 * Called from the map / write / read methods to verify that the
408 * caller is permitted to access the buffer object.
409 * This member may be set to NULL, which will refuse this kind of
410 * access for all buffer objects.
411 * This function should return 0 if access is granted, -EPERM otherwise.
413 int (*verify_access) (struct ttm_buffer_object *bo);
416 * In case a driver writer dislikes the TTM fence objects,
417 * the driver writer can replace those with sync objects of
418 * his / her own. If it turns out that no driver writer is
419 * using these. I suggest we remove these hooks and plug in
420 * fences directly. The bo driver needs the following functionality:
421 * See the corresponding functions in the fence object API
425 bool (*sync_obj_signaled) (void *sync_obj);
426 int (*sync_obj_wait) (void *sync_obj,
427 bool lazy, bool interruptible);
428 int (*sync_obj_flush) (void *sync_obj);
429 void (*sync_obj_unref) (void **sync_obj);
430 void *(*sync_obj_ref) (void *sync_obj);
432 /* hook to notify driver about a driver move so it
433 * can do tiling things */
434 void (*move_notify)(struct ttm_buffer_object *bo,
435 struct ttm_mem_reg *new_mem);
436 /* notify the driver we are taking a fault on this BO
437 * and have reserved it */
438 int (*fault_reserve_notify)(struct ttm_buffer_object *bo);
441 * notify the driver that we're about to swap out this bo
443 void (*swap_notify) (struct ttm_buffer_object *bo);
446 * Driver callback on when mapping io memory (for bo_move_memcpy
447 * for instance). TTM will take care to call io_mem_free whenever
448 * the mapping is not use anymore. io_mem_reserve & io_mem_free
451 int (*io_mem_reserve)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
452 void (*io_mem_free)(struct ttm_bo_device *bdev, struct ttm_mem_reg *mem);
456 * struct ttm_bo_global_ref - Argument to initialize a struct ttm_bo_global.
459 struct ttm_bo_global_ref {
460 struct drm_global_reference ref;
461 struct ttm_mem_global *mem_glob;
465 * struct ttm_bo_global - Buffer object driver global data.
467 * @mem_glob: Pointer to a struct ttm_mem_global object for accounting.
468 * @dummy_read_page: Pointer to a dummy page used for mapping requests
469 * of unpopulated pages.
470 * @shrink: A shrink callback object used for buffer object swap.
471 * @device_list_mutex: Mutex protecting the device list.
472 * This mutex is held while traversing the device list for pm options.
473 * @lru_lock: Spinlock protecting the bo subsystem lru lists.
474 * @device_list: List of buffer object devices.
475 * @swap_lru: Lru list of buffer objects used for swapping.
478 struct ttm_bo_global {
482 * Constant after init.
485 struct ttm_mem_global *mem_glob;
486 struct vm_page *dummy_read_page;
487 struct ttm_mem_shrink shrink;
488 struct lock device_list_mutex;
489 struct lock lru_lock;
492 * Protected by device_list_mutex.
494 struct list_head device_list;
497 * Protected by the lru_lock.
499 struct list_head swap_lru;
502 * Internal protection.
508 #define TTM_NUM_MEM_TYPES 8
510 #define TTM_BO_PRIV_FLAG_MOVING 0 /* Buffer object is moving and needs
511 idling before CPU mapping */
512 #define TTM_BO_PRIV_FLAG_MAX 1
513 #define TTM_BO_PRIV_FLAG_ACTIVE 2 /* Used for release sequencing */
515 * struct ttm_bo_device - Buffer object driver device-specific data.
517 * @driver: Pointer to a struct ttm_bo_driver struct setup by the driver.
518 * @man: An array of mem_type_managers.
519 * @fence_lock: Protects the synchronizing members on *all* bos belonging
521 * @addr_space_mm: Range manager for the device address space.
522 * lru_lock: Spinlock that protects the buffer+device lru lists and
524 * @val_seq: Current validation sequence.
525 * @dev_mapping: A pointer to the struct address_space representing the
526 * device address space.
527 * @wq: Work queue structure for the delayed delete workqueue.
531 struct ttm_bo_device {
534 * Constant after bo device init / atomic.
536 struct list_head device_list;
537 struct ttm_bo_global *glob;
538 struct ttm_bo_driver *driver;
540 struct ttm_mem_type_manager man[TTM_NUM_MEM_TYPES];
541 struct lock fence_lock;
543 * Protected by the vm lock.
546 RB_HEAD(ttm_bo_device_buffer_objects, ttm_buffer_object) addr_space_rb;
547 struct drm_mm addr_space_mm;
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 vm_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 vm_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 vm_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 vm_object *persistent_swap_storage);
691 * @bdev: Pointer to a struct ttm_bo_device.
692 * @mem: A valid struct ttm_mem_reg.
694 * Returns true if the memory described by @mem is PCI memory,
697 extern bool ttm_mem_reg_is_pci(struct ttm_bo_device *bdev,
698 struct ttm_mem_reg *mem);
703 * @bo: Pointer to a struct ttm_buffer_object. the data of which
704 * we want to allocate space for.
705 * @proposed_placement: Proposed new placement for the buffer object.
706 * @mem: A struct ttm_mem_reg.
707 * @interruptible: Sleep interruptible when sliping.
708 * @no_wait_gpu: Return immediately if the GPU is busy.
710 * Allocate memory space for the buffer object pointed to by @bo, using
711 * the placement flags in @mem, potentially evicting other idle buffer objects.
712 * This function may sleep while waiting for space to become available.
714 * -EBUSY: No space available (only if no_wait == 1).
715 * -ENOMEM: Could not allocate memory for the buffer object, either due to
716 * fragmentation or concurrent allocators.
717 * -ERESTARTSYS: An interruptible sleep was interrupted by a signal.
719 extern int ttm_bo_mem_space(struct ttm_buffer_object *bo,
720 struct ttm_placement *placement,
721 struct ttm_mem_reg *mem,
725 extern void ttm_bo_mem_put(struct ttm_buffer_object *bo,
726 struct ttm_mem_reg *mem);
727 extern void ttm_bo_mem_put_locked(struct ttm_buffer_object *bo,
728 struct ttm_mem_reg *mem);
730 extern void ttm_bo_global_release(struct drm_global_reference *ref);
731 extern int ttm_bo_global_init(struct drm_global_reference *ref);
733 extern int ttm_bo_device_release(struct ttm_bo_device *bdev);
738 * @bdev: A pointer to a struct ttm_bo_device to initialize.
739 * @glob: A pointer to an initialized struct ttm_bo_global.
740 * @driver: A pointer to a struct ttm_bo_driver set up by the caller.
741 * @file_page_offset: Offset into the device address space that is available
742 * for buffer data. This ensures compatibility with other users of the
745 * Initializes a struct ttm_bo_device:
749 extern int ttm_bo_device_init(struct ttm_bo_device *bdev,
750 struct ttm_bo_global *glob,
751 struct ttm_bo_driver *driver,
752 uint64_t file_page_offset, bool need_dma32);
755 * ttm_bo_unmap_virtual
757 * @bo: tear down the virtual mappings for this BO
759 extern void ttm_bo_unmap_virtual(struct ttm_buffer_object *bo);
762 * ttm_bo_unmap_virtual
764 * @bo: tear down the virtual mappings for this BO
766 * The caller must take ttm_mem_io_lock before calling this function.
768 extern void ttm_bo_unmap_virtual_locked(struct ttm_buffer_object *bo);
770 extern int ttm_mem_io_reserve_vm(struct ttm_buffer_object *bo);
771 extern void ttm_mem_io_free_vm(struct ttm_buffer_object *bo);
772 extern int ttm_mem_io_lock(struct ttm_mem_type_manager *man,
774 extern void ttm_mem_io_unlock(struct ttm_mem_type_manager *man);
780 * @bo: A pointer to a struct ttm_buffer_object.
781 * @interruptible: Sleep interruptible if waiting.
782 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
783 * @use_sequence: If @bo is already reserved, Only sleep waiting for
784 * it to become unreserved if @sequence < (@bo)->sequence.
786 * Locks a buffer object for validation. (Or prevents other processes from
787 * locking it for validation) and removes it from lru lists, while taking
788 * a number of measures to prevent deadlocks.
790 * Deadlocks may occur when two processes try to reserve multiple buffers in
791 * different order, either by will or as a result of a buffer being evicted
792 * to make room for a buffer already reserved. (Buffers are reserved before
793 * they are evicted). The following algorithm prevents such deadlocks from
795 * Processes attempting to reserve multiple buffers other than for eviction,
796 * (typically execbuf), should first obtain a unique 32-bit
797 * validation sequence number,
798 * and call this function with @use_sequence == 1 and @sequence == the unique
799 * sequence number. If upon call of this function, the buffer object is already
800 * reserved, the validation sequence is checked against the validation
801 * sequence of the process currently reserving the buffer,
802 * and if the current validation sequence is greater than that of the process
803 * holding the reservation, the function returns -EAGAIN. Otherwise it sleeps
804 * waiting for the buffer to become unreserved, after which it retries
806 * The caller should, when receiving an -EAGAIN error
807 * release all its buffer reservations, wait for @bo to become unreserved, and
808 * then rerun the validation with the same validation sequence. This procedure
809 * will always guarantee that the process with the lowest validation sequence
810 * will eventually succeed, preventing both deadlocks and starvation.
813 * -EAGAIN: The reservation may cause a deadlock.
814 * Release all buffer reservations, wait for @bo to become unreserved and
815 * try again. (only if use_sequence == 1).
816 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
817 * a signal. Release all buffer reservations and return to user-space.
818 * -EBUSY: The function needed to sleep, but @no_wait was true
819 * -EDEADLK: Bo already reserved using @sequence. This error code will only
820 * be returned if @use_sequence is set to true.
822 extern int ttm_bo_reserve(struct ttm_buffer_object *bo,
824 bool no_wait, bool use_sequence, uint32_t sequence);
827 * ttm_bo_reserve_slowpath_nolru:
828 * @bo: A pointer to a struct ttm_buffer_object.
829 * @interruptible: Sleep interruptible if waiting.
830 * @sequence: Set (@bo)->sequence to this value after lock
832 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
833 * from all our other reservations. Because there are no other reservations
834 * held by us, this function cannot deadlock any more.
836 * Will not remove reserved buffers from the lru lists.
837 * Otherwise identical to ttm_bo_reserve_slowpath.
839 extern int ttm_bo_reserve_slowpath_nolru(struct ttm_buffer_object *bo,
845 * ttm_bo_reserve_slowpath:
846 * @bo: A pointer to a struct ttm_buffer_object.
847 * @interruptible: Sleep interruptible if waiting.
848 * @sequence: Set (@bo)->sequence to this value after lock
850 * This is called after ttm_bo_reserve returns -EAGAIN and we backed off
851 * from all our other reservations. Because there are no other reservations
852 * held by us, this function cannot deadlock any more.
854 extern int ttm_bo_reserve_slowpath(struct ttm_buffer_object *bo,
855 bool interruptible, uint32_t sequence);
858 * ttm_bo_reserve_nolru:
860 * @bo: A pointer to a struct ttm_buffer_object.
861 * @interruptible: Sleep interruptible if waiting.
862 * @no_wait: Don't sleep while trying to reserve, rather return -EBUSY.
863 * @use_sequence: If @bo is already reserved, Only sleep waiting for
864 * it to become unreserved if @sequence < (@bo)->sequence.
866 * Will not remove reserved buffers from the lru lists.
867 * Otherwise identical to ttm_bo_reserve.
870 * -EAGAIN: The reservation may cause a deadlock.
871 * Release all buffer reservations, wait for @bo to become unreserved and
872 * try again. (only if use_sequence == 1).
873 * -ERESTARTSYS: A wait for the buffer to become unreserved was interrupted by
874 * a signal. Release all buffer reservations and return to user-space.
875 * -EBUSY: The function needed to sleep, but @no_wait was true
876 * -EDEADLK: Bo already reserved using @sequence. This error code will only
877 * be returned if @use_sequence is set to true.
879 extern int ttm_bo_reserve_nolru(struct ttm_buffer_object *bo,
881 bool no_wait, bool use_sequence,
887 * @bo: A pointer to a struct ttm_buffer_object.
889 * Unreserve a previous reservation of @bo.
891 extern void ttm_bo_unreserve(struct ttm_buffer_object *bo);
894 * ttm_bo_unreserve_locked
896 * @bo: A pointer to a struct ttm_buffer_object.
898 * Unreserve a previous reservation of @bo.
899 * Needs to be called with struct ttm_bo_global::lru_lock held.
901 extern void ttm_bo_unreserve_locked(struct ttm_buffer_object *bo);
910 * @bo: A pointer to a struct ttm_buffer_object.
911 * @evict: 1: This is an eviction. Don't try to pipeline.
912 * @no_wait_gpu: Return immediately if the GPU is busy.
913 * @new_mem: struct ttm_mem_reg indicating where to move.
915 * Optimized move function for a buffer object with both old and
916 * new placement backed by a TTM. The function will, if successful,
917 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
918 * and update the (@bo)->mem placement flags. If unsuccessful, the old
919 * data remains untouched, and it's up to the caller to free the
920 * memory space indicated by @new_mem.
925 extern int ttm_bo_move_ttm(struct ttm_buffer_object *bo,
926 bool evict, bool no_wait_gpu,
927 struct ttm_mem_reg *new_mem);
932 * @bo: A pointer to a struct ttm_buffer_object.
933 * @evict: 1: This is an eviction. Don't try to pipeline.
934 * @no_wait_gpu: Return immediately if the GPU is busy.
935 * @new_mem: struct ttm_mem_reg indicating where to move.
937 * Fallback move function for a mappable buffer object in mappable memory.
938 * The function will, if successful,
939 * free any old aperture space, and set (@new_mem)->mm_node to NULL,
940 * and update the (@bo)->mem placement flags. If unsuccessful, the old
941 * data remains untouched, and it's up to the caller to free the
942 * memory space indicated by @new_mem.
947 extern int ttm_bo_move_memcpy(struct ttm_buffer_object *bo,
948 bool evict, bool no_wait_gpu,
949 struct ttm_mem_reg *new_mem);
952 * ttm_bo_free_old_node
954 * @bo: A pointer to a struct ttm_buffer_object.
956 * Utility function to free an old placement after a successful move.
958 extern void ttm_bo_free_old_node(struct ttm_buffer_object *bo);
961 * ttm_bo_move_accel_cleanup.
963 * @bo: A pointer to a struct ttm_buffer_object.
964 * @sync_obj: A sync object that signals when moving is complete.
965 * @evict: This is an evict move. Don't return until the buffer is idle.
966 * @no_wait_gpu: Return immediately if the GPU is busy.
967 * @new_mem: struct ttm_mem_reg indicating where to move.
969 * Accelerated move function to be called when an accelerated move
970 * has been scheduled. The function will create a new temporary buffer object
971 * representing the old placement, and put the sync object on both buffer
972 * objects. After that the newly created buffer object is unref'd to be
973 * destroyed when the move is complete. This will help pipeline
977 extern int ttm_bo_move_accel_cleanup(struct ttm_buffer_object *bo,
979 bool evict, bool no_wait_gpu,
980 struct ttm_mem_reg *new_mem);
984 * @c_state: Caching state.
985 * @tmp: Page protection flag for a normal, cached mapping.
987 * Utility function that returns the pgprot_t that should be used for
988 * setting up a PTE with the caching model indicated by @c_state.
990 extern vm_memattr_t ttm_io_prot(uint32_t caching_flags);
992 extern const struct ttm_mem_type_manager_func ttm_bo_manager_func;
994 #if (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
996 #include <linux/agp_backend.h>
1001 * @bdev: Pointer to a struct ttm_bo_device.
1002 * @bridge: The agp bridge this device is sitting on.
1003 * @size: Size of the data needed backing.
1004 * @page_flags: Page flags as identified by TTM_PAGE_FLAG_XX flags.
1005 * @dummy_read_page: See struct ttm_bo_device.
1008 * Create a TTM backend that uses the indicated AGP bridge as an aperture
1009 * for TT memory. This function uses the linux agpgart interface to
1010 * bind and unbind memory backing a ttm_tt.
1012 extern struct ttm_tt *ttm_agp_tt_create(struct ttm_bo_device *bdev,
1013 struct agp_bridge_data *bridge,
1014 unsigned long size, uint32_t page_flags,
1015 struct vm_page *dummy_read_page);
1016 int ttm_agp_tt_populate(struct ttm_tt *ttm);
1017 void ttm_agp_tt_unpopulate(struct ttm_tt *ttm);
1021 int ttm_bo_cmp_rb_tree_items(struct ttm_buffer_object *a,
1022 struct ttm_buffer_object *b);
1023 RB_PROTOTYPE(ttm_bo_device_buffer_objects, ttm_buffer_object, vm_rb,
1024 ttm_bo_cmp_rb_tree_items);