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>
31 #ifndef _TTM_BO_API_H_
32 #define _TTM_BO_API_H_
34 #include <drm/drm_hashtab.h>
35 #include <drm/drm_vma_manager.h>
36 #include <linux/kref.h>
37 #include <linux/list.h>
38 #include <linux/wait.h>
39 #include <linux/mutex.h>
41 #include <linux/bitmap.h>
42 #include <linux/reservation.h>
53 * struct ttm_bus_placement
55 * @addr: mapped virtual address
56 * @base: bus base address
57 * @is_iomem: is this io memory ?
59 * @offset: offset from the base address
60 * @io_reserved_vm: The VM system has a refcount in @io_reserved_count
61 * @io_reserved_count: Refcounting the numbers of callers to ttm_mem_io_reserve
63 * Structure indicating the bus placement of an object.
65 struct ttm_bus_placement {
72 uint64_t io_reserved_count;
79 * @mm_node: Memory manager node.
80 * @size: Requested size of memory region.
81 * @num_pages: Actual size of memory region in pages.
82 * @page_alignment: Page alignment.
83 * @placement: Placement flags.
84 * @bus: Placement on io bus accessible to the CPU
86 * Structure indicating the placement and space resources used by a
94 unsigned long num_pages;
95 uint32_t page_alignment;
98 struct ttm_bus_placement bus;
104 * @ttm_bo_type_device: These are 'normal' buffers that can
105 * be mmapped by user space. Each of these bos occupy a slot in the
106 * device address space, that can be used for normal vm operations.
108 * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,
109 * but they cannot be accessed from user-space. For kernel-only use.
111 * @ttm_bo_type_sg: Buffer made from dmabuf sg table shared with another
124 * struct ttm_buffer_object
126 * @bdev: Pointer to the buffer object device structure.
127 * @type: The bo type.
128 * @destroy: Destruction function. If NULL, kfree is used.
129 * @num_pages: Actual number of pages.
130 * @acc_size: Accounted size for this object.
131 * @kref: Reference count of this buffer object. When this refcount reaches
132 * zero, the object is put on the delayed delete list.
133 * @list_kref: List reference count of this buffer object. This member is
134 * used to avoid destruction while the buffer object is still on a list.
135 * Lru lists may keep one refcount, the delayed delete list, and kref != 0
136 * keeps one refcount. When this refcount reaches zero,
137 * the object is destroyed.
138 * @mem: structure describing current placement.
139 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
140 * pinned in physical memory. If this behaviour is not desired, this member
141 * holds a pointer to a persistent shmem object.
142 * @ttm: TTM structure holding system pages.
143 * @evicted: Whether the object was evicted without user-space knowing.
144 * @cpu_writes: For synchronization. Number of cpu writers.
145 * @lru: List head for the lru list.
146 * @ddestroy: List head for the delayed destroy list.
147 * @swap: List head for swap LRU list.
148 * @moving: Fence set when BO is moving
149 * @vma_node: Address space manager node.
150 * @offset: The current GPU offset, which can have different meanings
151 * depending on the memory type. For SYSTEM type memory, it should be 0.
152 * @cur_placement: Hint of current placement.
153 * @wu_mutex: Wait unreserved mutex.
155 * Base class for TTM buffer object, that deals with data placement and CPU
156 * mappings. GPU mappings are really up to the driver, but for simpler GPUs
157 * the driver can usually use the placement offset @offset directly as the
158 * GPU virtual address. For drivers implementing multiple
159 * GPU memory manager contexts, the driver should manage the address space
160 * in these contexts separately and use these objects to get the correct
161 * placement and caching for these GPU maps. This makes it possible to use
162 * these objects for even quite elaborate memory management schemes.
163 * The destroy member, the API visibility of this object makes it possible
164 * to derive driver specific types.
167 struct ttm_buffer_object {
169 * Members constant at init.
172 struct ttm_bo_global *glob;
173 struct ttm_bo_device *bdev;
174 enum ttm_bo_type type;
175 void (*destroy) (struct ttm_buffer_object *);
176 unsigned long num_pages;
180 * Members not needing protection.
184 struct kref list_kref;
187 * Members protected by the bo::resv::reserved lock.
190 struct ttm_mem_reg mem;
191 struct file *persistent_swap_storage;
196 * Members protected by the bo::reserved lock only when written to.
199 atomic_t cpu_writers;
202 * Members protected by the bdev::lru_lock.
205 struct list_head lru;
206 struct list_head ddestroy;
207 struct list_head swap;
208 struct list_head io_reserve_lru;
211 * Members protected by a bo reservation.
214 struct dma_fence *moving;
216 struct drm_vma_offset_node vma_node;
221 * Special members that are protected by the reserve lock
222 * and the bo::lock when written to. Can be read with
223 * either of these locks held.
226 uint64_t offset; /* GPU address space is independent of CPU word size */
227 uint32_t cur_placement;
231 struct reservation_object *resv;
232 struct reservation_object ttm_resv;
233 struct mutex wu_mutex;
237 * struct ttm_bo_kmap_obj
239 * @virtual: The current kernel virtual address.
240 * @page: The page when kmap'ing a single page.
241 * @bo_kmap_type: Type of bo_kmap.
243 * Object describing a kernel mapping. Since a TTM bo may be located
244 * in various memory types with various caching policies, the
245 * mapping can either be an ioremap, a vmap, a kmap or part of a
249 #define TTM_BO_MAP_IOMEM_MASK 0x80
250 struct ttm_bo_kmap_obj {
254 ttm_bo_map_iomap = 1 | TTM_BO_MAP_IOMEM_MASK,
257 ttm_bo_map_premapped = 4 | TTM_BO_MAP_IOMEM_MASK,
259 struct ttm_buffer_object *bo;
263 * ttm_bo_reference - reference a struct ttm_buffer_object
265 * @bo: The buffer object.
267 * Returns a refcounted pointer to a buffer object.
270 static inline struct ttm_buffer_object *
271 ttm_bo_reference(struct ttm_buffer_object *bo)
278 * ttm_bo_wait - wait for buffer idle.
280 * @bo: The buffer object.
281 * @interruptible: Use interruptible wait.
282 * @no_wait: Return immediately if buffer is busy.
284 * This function must be called with the bo::mutex held, and makes
285 * sure any previous rendering to the buffer is completed.
286 * Note: It might be necessary to block validations before the
287 * wait by reserving the buffer.
288 * Returns -EBUSY if no_wait is true and the buffer is busy.
289 * Returns -ERESTARTSYS if interrupted by a signal.
291 extern int ttm_bo_wait(struct ttm_buffer_object *bo,
292 bool interruptible, bool no_wait);
295 * ttm_bo_mem_compat - Check if proposed placement is compatible with a bo
297 * @placement: Return immediately if buffer is busy.
298 * @mem: The struct ttm_mem_reg indicating the region where the bo resides
299 * @new_flags: Describes compatible placement found
301 * Returns true if the placement is compatible
303 extern bool ttm_bo_mem_compat(struct ttm_placement *placement,
304 struct ttm_mem_reg *mem,
305 uint32_t *new_flags);
310 * @bo: The buffer object.
311 * @placement: Proposed placement for the buffer object.
312 * @interruptible: Sleep interruptible if sleeping.
313 * @no_wait_gpu: Return immediately if the GPU is busy.
315 * Changes placement and caching policy of the buffer object
316 * according proposed placement.
318 * -EINVAL on invalid proposed placement.
319 * -ENOMEM on out-of-memory condition.
320 * -EBUSY if no_wait is true and buffer busy.
321 * -ERESTARTSYS if interrupted by a signal.
323 extern int ttm_bo_validate(struct ttm_buffer_object *bo,
324 struct ttm_placement *placement,
331 * @bo: The buffer object.
333 * Unreference and clear a pointer to a buffer object.
335 extern void ttm_bo_unref(struct ttm_buffer_object **bo);
339 * ttm_bo_list_ref_sub
341 * @bo: The buffer object.
342 * @count: The number of references with which to decrease @bo::list_kref;
343 * @never_free: The refcount should not reach zero with this operation.
345 * Release @count lru list references to this buffer object.
347 extern void ttm_bo_list_ref_sub(struct ttm_buffer_object *bo, int count,
353 * @bo: The buffer object.
355 * Add this bo to the relevant mem type lru and, if it's backed by
356 * system pages (ttms) to the swap list.
357 * This function must be called with struct ttm_bo_global::lru_lock held, and
358 * is typically called immediately prior to unreserving a bo.
360 extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo);
363 * ttm_bo_del_from_lru
365 * @bo: The buffer object.
367 * Remove this bo from all lru lists used to lookup and reserve an object.
368 * This function must be called with struct ttm_bo_global::lru_lock held,
369 * and is usually called just immediately after the bo has been reserved to
370 * avoid recursive reservation from lru lists.
372 extern int ttm_bo_del_from_lru(struct ttm_buffer_object *bo);
375 * ttm_bo_move_to_lru_tail
377 * @bo: The buffer object.
379 * Move this BO to the tail of all lru lists used to lookup and reserve an
380 * object. This function must be called with struct ttm_bo_global::lru_lock
381 * held, and is used to make a BO less likely to be considered for eviction.
383 extern void ttm_bo_move_to_lru_tail(struct ttm_buffer_object *bo);
386 * ttm_bo_lock_delayed_workqueue
388 * Prevent the delayed workqueue from running.
390 * True if the workqueue was queued at the time
392 extern int ttm_bo_lock_delayed_workqueue(struct ttm_bo_device *bdev);
395 * ttm_bo_unlock_delayed_workqueue
397 * Allows the delayed workqueue to run.
399 extern void ttm_bo_unlock_delayed_workqueue(struct ttm_bo_device *bdev,
403 * ttm_bo_eviction_valuable
405 * @bo: The buffer object to evict
406 * @place: the placement we need to make room for
408 * Check if it is valuable to evict the BO to make room for the given placement.
410 bool ttm_bo_eviction_valuable(struct ttm_buffer_object *bo,
411 const struct ttm_place *place);
414 * ttm_bo_synccpu_write_grab
416 * @bo: The buffer object:
417 * @no_wait: Return immediately if buffer is busy.
419 * Synchronizes a buffer object for CPU RW access. This means
420 * command submission that affects the buffer will return -EBUSY
421 * until ttm_bo_synccpu_write_release is called.
424 * -EBUSY if the buffer is busy and no_wait is true.
425 * -ERESTARTSYS if interrupted by a signal.
428 ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait);
431 * ttm_bo_synccpu_write_release:
433 * @bo : The buffer object.
435 * Releases a synccpu lock.
437 extern void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo);
442 * @bdev: Pointer to a ttm_bo_device struct.
443 * @bo_size: size of the buffer object in byte.
444 * @struct_size: size of the structure holding buffer object datas
446 * Returns size to account for a buffer object
448 size_t ttm_bo_acc_size(struct ttm_bo_device *bdev,
449 unsigned long bo_size,
450 unsigned struct_size);
451 size_t ttm_bo_dma_acc_size(struct ttm_bo_device *bdev,
452 unsigned long bo_size,
453 unsigned struct_size);
458 * @bdev: Pointer to a ttm_bo_device struct.
459 * @bo: Pointer to a ttm_buffer_object to be initialized.
460 * @size: Requested size of buffer object.
461 * @type: Requested type of buffer object.
462 * @flags: Initial placement flags.
463 * @page_alignment: Data alignment in pages.
464 * @interruptible: If needing to sleep to wait for GPU resources,
465 * sleep interruptible.
466 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
467 * pinned in physical memory. If this behaviour is not desired, this member
468 * holds a pointer to a persistent shmem object. Typically, this would
469 * point to the shmem object backing a GEM object if TTM is used to back a
470 * GEM user interface.
471 * @acc_size: Accounted size for this object.
472 * @resv: Pointer to a reservation_object, or NULL to let ttm allocate one.
473 * @destroy: Destroy function. Use NULL for kfree().
475 * This function initializes a pre-allocated struct ttm_buffer_object.
476 * As this object may be part of a larger structure, this function,
477 * together with the @destroy function,
478 * enables driver-specific objects derived from a ttm_buffer_object.
479 * On successful return, the object kref and list_kref are set to 1.
480 * If a failure occurs, the function will call the @destroy function, or
481 * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is
482 * illegal and will likely cause memory corruption.
485 * -ENOMEM: Out of memory.
486 * -EINVAL: Invalid placement flags.
487 * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources.
490 extern int ttm_bo_init(struct ttm_bo_device *bdev,
491 struct ttm_buffer_object *bo,
493 enum ttm_bo_type type,
494 struct ttm_placement *placement,
495 uint32_t page_alignment,
497 struct file *persistent_swap_storage,
500 struct reservation_object *resv,
501 void (*destroy) (struct ttm_buffer_object *));
506 * @bdev: Pointer to a ttm_bo_device struct.
507 * @size: Requested size of buffer object.
508 * @type: Requested type of buffer object.
509 * @placement: Initial placement.
510 * @page_alignment: Data alignment in pages.
511 * @interruptible: If needing to sleep while waiting for GPU resources,
512 * sleep interruptible.
513 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
514 * pinned in physical memory. If this behaviour is not desired, this member
515 * holds a pointer to a persistent shmem object. Typically, this would
516 * point to the shmem object backing a GEM object if TTM is used to back a
517 * GEM user interface.
518 * @p_bo: On successful completion *p_bo points to the created object.
520 * This function allocates a ttm_buffer_object, and then calls ttm_bo_init
521 * on that object. The destroy function is set to kfree().
523 * -ENOMEM: Out of memory.
524 * -EINVAL: Invalid placement flags.
525 * -ERESTARTSYS: Interrupted by signal while waiting for resources.
528 extern int ttm_bo_create(struct ttm_bo_device *bdev,
530 enum ttm_bo_type type,
531 struct ttm_placement *placement,
532 uint32_t page_alignment,
534 struct file *persistent_swap_storage,
535 struct ttm_buffer_object **p_bo);
540 * @bdev: Pointer to a ttm_bo_device struct.
541 * @mem_type: The memory type.
542 * @p_size: size managed area in pages.
544 * Initialize a manager for a given memory type.
545 * Note: if part of driver firstopen, it must be protected from a
546 * potentially racing lastclose.
548 * -EINVAL: invalid size or memory type.
549 * -ENOMEM: Not enough memory.
550 * May also return driver-specified errors.
553 extern int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type,
554 unsigned long p_size);
558 * @bdev: Pointer to a ttm_bo_device struct.
559 * @mem_type: The memory type.
561 * Take down a manager for a given memory type after first walking
562 * the LRU list to evict any buffers left alive.
564 * Normally, this function is part of lastclose() or unload(), and at that
565 * point there shouldn't be any buffers left created by user-space, since
566 * there should've been removed by the file descriptor release() method.
567 * However, before this function is run, make sure to signal all sync objects,
568 * and verify that the delayed delete queue is empty. The driver must also
569 * make sure that there are no NO_EVICT buffers present in this memory type
570 * when the call is made.
572 * If this function is part of a VT switch, the caller must make sure that
573 * there are no appications currently validating buffers before this
574 * function is called. The caller can do that by first taking the
575 * struct ttm_bo_device::ttm_lock in write mode.
578 * -EINVAL: invalid or uninitialized memory type.
579 * -EBUSY: There are still buffers left in this memory type.
582 extern int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type);
587 * @bdev: Pointer to a ttm_bo_device struct.
588 * @mem_type: The memory type.
590 * Evicts all buffers on the lru list of the memory type.
591 * This is normally part of a VT switch or an
592 * out-of-memory-space-due-to-fragmentation handler.
593 * The caller must make sure that there are no other processes
594 * currently validating buffers, and can do that by taking the
595 * struct ttm_bo_device::ttm_lock in write mode.
598 * -EINVAL: Invalid or uninitialized memory type.
599 * -ERESTARTSYS: The call was interrupted by a signal while waiting to
603 extern int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type);
606 * ttm_kmap_obj_virtual
608 * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap.
609 * @is_iomem: Pointer to an integer that on return indicates 1 if the
610 * virtual map is io memory, 0 if normal memory.
612 * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap.
613 * If *is_iomem is 1 on return, the virtual address points to an io memory area,
614 * that should strictly be accessed by the iowriteXX() and similar functions.
617 static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map,
620 *is_iomem = !!(map->bo_kmap_type & TTM_BO_MAP_IOMEM_MASK);
627 * @bo: The buffer object.
628 * @start_page: The first page to map.
629 * @num_pages: Number of pages to map.
630 * @map: pointer to a struct ttm_bo_kmap_obj representing the map.
632 * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the
633 * data in the buffer object. The ttm_kmap_obj_virtual function can then be
634 * used to obtain a virtual address to the data.
637 * -ENOMEM: Out of memory.
638 * -EINVAL: Invalid range.
641 extern int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
642 unsigned long num_pages, struct ttm_bo_kmap_obj *map);
647 * @map: Object describing the map to unmap.
649 * Unmaps a kernel map set up by ttm_bo_kmap.
652 extern void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
655 * ttm_fbdev_mmap - mmap fbdev memory backed by a ttm buffer object.
657 * @vma: vma as input from the fbdev mmap method.
658 * @bo: The bo backing the address space. The address space will
659 * have the same size as the bo, and start at offset 0.
661 * This function is intended to be called by the fbdev mmap method
662 * if the fbdev address space is to be backed by a bo.
665 extern int ttm_fbdev_mmap(struct vm_area_struct *vma,
666 struct ttm_buffer_object *bo);
669 * ttm_bo_mmap - mmap out of the ttm device address space.
671 * @filp: filp as input from the mmap method.
672 * @vma: vma as input from the mmap method.
673 * @bdev: Pointer to the ttm_bo_device with the address space manager.
675 * This function is intended to be called by the device mmap method.
676 * if the device address space is to be backed by the bo manager.
679 extern int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma,
680 struct ttm_bo_device *bdev);
685 * @bdev: Pointer to the struct ttm_bo_device.
686 * @filp: Pointer to the struct file attempting to read / write.
687 * @wbuf: User-space pointer to address of buffer to write. NULL on read.
688 * @rbuf: User-space pointer to address of buffer to read into.
690 * @count: Number of bytes to read / write.
691 * @f_pos: Pointer to current file position.
692 * @write: 1 for read, 0 for write.
694 * This function implements read / write into ttm buffer objects, and is
696 * be called from the fops::read and fops::write method.
698 * See man (2) write, man(2) read. In particular,
699 * the function may return -ERESTARTSYS if
700 * interrupted by a signal.
703 extern ssize_t ttm_bo_io(struct ttm_bo_device *bdev, struct file *filp,
704 const char __user *wbuf, char __user *rbuf,
705 size_t count, loff_t *f_pos, bool write);
707 extern void ttm_bo_swapout_all(struct ttm_bo_device *bdev);
708 extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo);