Loading...
1/**************************************************************************
2 *
3 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
4 * All Rights Reserved.
5 *
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:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
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.
25 *
26 **************************************************************************/
27/*
28 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
29 */
30
31#ifndef _TTM_BO_API_H_
32#define _TTM_BO_API_H_
33
34#include <drm/drm_gem.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>
40#include <linux/mm.h>
41#include <linux/bitmap.h>
42#include <linux/dma-resv.h>
43
44#include "ttm_resource.h"
45
46struct ttm_global;
47
48struct ttm_device;
49
50struct iosys_map;
51
52struct drm_mm_node;
53
54struct ttm_placement;
55
56struct ttm_place;
57
58/**
59 * enum ttm_bo_type
60 *
61 * @ttm_bo_type_device: These are 'normal' buffers that can
62 * be mmapped by user space. Each of these bos occupy a slot in the
63 * device address space, that can be used for normal vm operations.
64 *
65 * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,
66 * but they cannot be accessed from user-space. For kernel-only use.
67 *
68 * @ttm_bo_type_sg: Buffer made from dmabuf sg table shared with another
69 * driver.
70 */
71
72enum ttm_bo_type {
73 ttm_bo_type_device,
74 ttm_bo_type_kernel,
75 ttm_bo_type_sg
76};
77
78struct ttm_tt;
79
80/**
81 * struct ttm_buffer_object
82 *
83 * @base: drm_gem_object superclass data.
84 * @bdev: Pointer to the buffer object device structure.
85 * @type: The bo type.
86 * @page_alignment: Page alignment.
87 * @destroy: Destruction function. If NULL, kfree is used.
88 * @num_pages: Actual number of pages.
89 * @kref: Reference count of this buffer object. When this refcount reaches
90 * zero, the object is destroyed or put on the delayed delete list.
91 * @mem: structure describing current placement.
92 * @ttm: TTM structure holding system pages.
93 * @evicted: Whether the object was evicted without user-space knowing.
94 * @deleted: True if the object is only a zombie and already deleted.
95 * @ddestroy: List head for the delayed destroy list.
96 * @swap: List head for swap LRU list.
97 * @offset: The current GPU offset, which can have different meanings
98 * depending on the memory type. For SYSTEM type memory, it should be 0.
99 * @cur_placement: Hint of current placement.
100 *
101 * Base class for TTM buffer object, that deals with data placement and CPU
102 * mappings. GPU mappings are really up to the driver, but for simpler GPUs
103 * the driver can usually use the placement offset @offset directly as the
104 * GPU virtual address. For drivers implementing multiple
105 * GPU memory manager contexts, the driver should manage the address space
106 * in these contexts separately and use these objects to get the correct
107 * placement and caching for these GPU maps. This makes it possible to use
108 * these objects for even quite elaborate memory management schemes.
109 * The destroy member, the API visibility of this object makes it possible
110 * to derive driver specific types.
111 */
112
113struct ttm_buffer_object {
114 struct drm_gem_object base;
115
116 /**
117 * Members constant at init.
118 */
119
120 struct ttm_device *bdev;
121 enum ttm_bo_type type;
122 uint32_t page_alignment;
123 void (*destroy) (struct ttm_buffer_object *);
124
125 /**
126 * Members not needing protection.
127 */
128 struct kref kref;
129
130 /**
131 * Members protected by the bo::resv::reserved lock.
132 */
133
134 struct ttm_resource *resource;
135 struct ttm_tt *ttm;
136 bool deleted;
137 struct ttm_lru_bulk_move *bulk_move;
138
139 /**
140 * Members protected by the bdev::lru_lock.
141 */
142
143 struct list_head ddestroy;
144
145 /**
146 * Members protected by a bo reservation.
147 */
148
149 unsigned priority;
150 unsigned pin_count;
151
152 /**
153 * Special members that are protected by the reserve lock
154 * and the bo::lock when written to. Can be read with
155 * either of these locks held.
156 */
157
158 struct sg_table *sg;
159};
160
161/**
162 * struct ttm_bo_kmap_obj
163 *
164 * @virtual: The current kernel virtual address.
165 * @page: The page when kmap'ing a single page.
166 * @bo_kmap_type: Type of bo_kmap.
167 *
168 * Object describing a kernel mapping. Since a TTM bo may be located
169 * in various memory types with various caching policies, the
170 * mapping can either be an ioremap, a vmap, a kmap or part of a
171 * premapped region.
172 */
173
174#define TTM_BO_MAP_IOMEM_MASK 0x80
175struct ttm_bo_kmap_obj {
176 void *virtual;
177 struct page *page;
178 enum {
179 ttm_bo_map_iomap = 1 | TTM_BO_MAP_IOMEM_MASK,
180 ttm_bo_map_vmap = 2,
181 ttm_bo_map_kmap = 3,
182 ttm_bo_map_premapped = 4 | TTM_BO_MAP_IOMEM_MASK,
183 } bo_kmap_type;
184 struct ttm_buffer_object *bo;
185};
186
187/**
188 * struct ttm_operation_ctx
189 *
190 * @interruptible: Sleep interruptible if sleeping.
191 * @no_wait_gpu: Return immediately if the GPU is busy.
192 * @gfp_retry_mayfail: Set the __GFP_RETRY_MAYFAIL when allocation pages.
193 * @allow_res_evict: Allow eviction of reserved BOs. Can be used when multiple
194 * BOs share the same reservation object.
195 * @force_alloc: Don't check the memory account during suspend or CPU page
196 * faults. Should only be used by TTM internally.
197 * @resv: Reservation object to allow reserved evictions with.
198 *
199 * Context for TTM operations like changing buffer placement or general memory
200 * allocation.
201 */
202struct ttm_operation_ctx {
203 bool interruptible;
204 bool no_wait_gpu;
205 bool gfp_retry_mayfail;
206 bool allow_res_evict;
207 bool force_alloc;
208 struct dma_resv *resv;
209 uint64_t bytes_moved;
210};
211
212/**
213 * ttm_bo_get - reference a struct ttm_buffer_object
214 *
215 * @bo: The buffer object.
216 */
217static inline void ttm_bo_get(struct ttm_buffer_object *bo)
218{
219 kref_get(&bo->kref);
220}
221
222/**
223 * ttm_bo_get_unless_zero - reference a struct ttm_buffer_object unless
224 * its refcount has already reached zero.
225 * @bo: The buffer object.
226 *
227 * Used to reference a TTM buffer object in lookups where the object is removed
228 * from the lookup structure during the destructor and for RCU lookups.
229 *
230 * Returns: @bo if the referencing was successful, NULL otherwise.
231 */
232static inline __must_check struct ttm_buffer_object *
233ttm_bo_get_unless_zero(struct ttm_buffer_object *bo)
234{
235 if (!kref_get_unless_zero(&bo->kref))
236 return NULL;
237 return bo;
238}
239
240/**
241 * ttm_bo_wait - wait for buffer idle.
242 *
243 * @bo: The buffer object.
244 * @interruptible: Use interruptible wait.
245 * @no_wait: Return immediately if buffer is busy.
246 *
247 * This function must be called with the bo::mutex held, and makes
248 * sure any previous rendering to the buffer is completed.
249 * Note: It might be necessary to block validations before the
250 * wait by reserving the buffer.
251 * Returns -EBUSY if no_wait is true and the buffer is busy.
252 * Returns -ERESTARTSYS if interrupted by a signal.
253 */
254int ttm_bo_wait(struct ttm_buffer_object *bo, bool interruptible, bool no_wait);
255
256static inline int ttm_bo_wait_ctx(struct ttm_buffer_object *bo, struct ttm_operation_ctx *ctx)
257{
258 return ttm_bo_wait(bo, ctx->interruptible, ctx->no_wait_gpu);
259}
260
261/**
262 * ttm_bo_validate
263 *
264 * @bo: The buffer object.
265 * @placement: Proposed placement for the buffer object.
266 * @ctx: validation parameters.
267 *
268 * Changes placement and caching policy of the buffer object
269 * according proposed placement.
270 * Returns
271 * -EINVAL on invalid proposed placement.
272 * -ENOMEM on out-of-memory condition.
273 * -EBUSY if no_wait is true and buffer busy.
274 * -ERESTARTSYS if interrupted by a signal.
275 */
276int ttm_bo_validate(struct ttm_buffer_object *bo,
277 struct ttm_placement *placement,
278 struct ttm_operation_ctx *ctx);
279
280/**
281 * ttm_bo_put
282 *
283 * @bo: The buffer object.
284 *
285 * Unreference a buffer object.
286 */
287void ttm_bo_put(struct ttm_buffer_object *bo);
288
289void ttm_bo_move_to_lru_tail(struct ttm_buffer_object *bo);
290void ttm_bo_set_bulk_move(struct ttm_buffer_object *bo,
291 struct ttm_lru_bulk_move *bulk);
292
293/**
294 * ttm_bo_lock_delayed_workqueue
295 *
296 * Prevent the delayed workqueue from running.
297 * Returns
298 * True if the workqueue was queued at the time
299 */
300int ttm_bo_lock_delayed_workqueue(struct ttm_device *bdev);
301
302/**
303 * ttm_bo_unlock_delayed_workqueue
304 *
305 * Allows the delayed workqueue to run.
306 */
307void ttm_bo_unlock_delayed_workqueue(struct ttm_device *bdev, int resched);
308
309/**
310 * ttm_bo_eviction_valuable
311 *
312 * @bo: The buffer object to evict
313 * @place: the placement we need to make room for
314 *
315 * Check if it is valuable to evict the BO to make room for the given placement.
316 */
317bool ttm_bo_eviction_valuable(struct ttm_buffer_object *bo,
318 const struct ttm_place *place);
319
320int ttm_bo_init_reserved(struct ttm_device *bdev, struct ttm_buffer_object *bo,
321 enum ttm_bo_type type, struct ttm_placement *placement,
322 uint32_t alignment, struct ttm_operation_ctx *ctx,
323 struct sg_table *sg, struct dma_resv *resv,
324 void (*destroy) (struct ttm_buffer_object *));
325int ttm_bo_init_validate(struct ttm_device *bdev, struct ttm_buffer_object *bo,
326 enum ttm_bo_type type, struct ttm_placement *placement,
327 uint32_t alignment, bool interruptible,
328 struct sg_table *sg, struct dma_resv *resv,
329 void (*destroy) (struct ttm_buffer_object *));
330
331/**
332 * ttm_kmap_obj_virtual
333 *
334 * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap.
335 * @is_iomem: Pointer to an integer that on return indicates 1 if the
336 * virtual map is io memory, 0 if normal memory.
337 *
338 * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap.
339 * If *is_iomem is 1 on return, the virtual address points to an io memory area,
340 * that should strictly be accessed by the iowriteXX() and similar functions.
341 */
342static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map,
343 bool *is_iomem)
344{
345 *is_iomem = !!(map->bo_kmap_type & TTM_BO_MAP_IOMEM_MASK);
346 return map->virtual;
347}
348
349/**
350 * ttm_bo_kmap
351 *
352 * @bo: The buffer object.
353 * @start_page: The first page to map.
354 * @num_pages: Number of pages to map.
355 * @map: pointer to a struct ttm_bo_kmap_obj representing the map.
356 *
357 * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the
358 * data in the buffer object. The ttm_kmap_obj_virtual function can then be
359 * used to obtain a virtual address to the data.
360 *
361 * Returns
362 * -ENOMEM: Out of memory.
363 * -EINVAL: Invalid range.
364 */
365int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
366 unsigned long num_pages, struct ttm_bo_kmap_obj *map);
367
368/**
369 * ttm_bo_kunmap
370 *
371 * @map: Object describing the map to unmap.
372 *
373 * Unmaps a kernel map set up by ttm_bo_kmap.
374 */
375void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
376
377/**
378 * ttm_bo_vmap
379 *
380 * @bo: The buffer object.
381 * @map: pointer to a struct iosys_map representing the map.
382 *
383 * Sets up a kernel virtual mapping, using ioremap or vmap to the
384 * data in the buffer object. The parameter @map returns the virtual
385 * address as struct iosys_map. Unmap the buffer with ttm_bo_vunmap().
386 *
387 * Returns
388 * -ENOMEM: Out of memory.
389 * -EINVAL: Invalid range.
390 */
391int ttm_bo_vmap(struct ttm_buffer_object *bo, struct iosys_map *map);
392
393/**
394 * ttm_bo_vunmap
395 *
396 * @bo: The buffer object.
397 * @map: Object describing the map to unmap.
398 *
399 * Unmaps a kernel map set up by ttm_bo_vmap().
400 */
401void ttm_bo_vunmap(struct ttm_buffer_object *bo, struct iosys_map *map);
402
403/**
404 * ttm_bo_mmap_obj - mmap memory backed by a ttm buffer object.
405 *
406 * @vma: vma as input from the fbdev mmap method.
407 * @bo: The bo backing the address space.
408 *
409 * Maps a buffer object.
410 */
411int ttm_bo_mmap_obj(struct vm_area_struct *vma, struct ttm_buffer_object *bo);
412
413/**
414 * ttm_bo_io
415 *
416 * @bdev: Pointer to the struct ttm_device.
417 * @filp: Pointer to the struct file attempting to read / write.
418 * @wbuf: User-space pointer to address of buffer to write. NULL on read.
419 * @rbuf: User-space pointer to address of buffer to read into.
420 * Null on write.
421 * @count: Number of bytes to read / write.
422 * @f_pos: Pointer to current file position.
423 * @write: 1 for read, 0 for write.
424 *
425 * This function implements read / write into ttm buffer objects, and is
426 * intended to
427 * be called from the fops::read and fops::write method.
428 * Returns:
429 * See man (2) write, man(2) read. In particular,
430 * the function may return -ERESTARTSYS if
431 * interrupted by a signal.
432 */
433ssize_t ttm_bo_io(struct ttm_device *bdev, struct file *filp,
434 const char __user *wbuf, char __user *rbuf,
435 size_t count, loff_t *f_pos, bool write);
436
437int ttm_bo_swapout(struct ttm_buffer_object *bo, struct ttm_operation_ctx *ctx,
438 gfp_t gfp_flags);
439
440void ttm_bo_pin(struct ttm_buffer_object *bo);
441void ttm_bo_unpin(struct ttm_buffer_object *bo);
442
443int ttm_mem_evict_first(struct ttm_device *bdev,
444 struct ttm_resource_manager *man,
445 const struct ttm_place *place,
446 struct ttm_operation_ctx *ctx,
447 struct ww_acquire_ctx *ticket);
448
449/* Default number of pre-faulted pages in the TTM fault handler */
450#define TTM_BO_VM_NUM_PREFAULT 16
451
452vm_fault_t ttm_bo_vm_reserve(struct ttm_buffer_object *bo,
453 struct vm_fault *vmf);
454
455vm_fault_t ttm_bo_vm_fault_reserved(struct vm_fault *vmf,
456 pgprot_t prot,
457 pgoff_t num_prefault);
458
459vm_fault_t ttm_bo_vm_fault(struct vm_fault *vmf);
460
461void ttm_bo_vm_open(struct vm_area_struct *vma);
462
463void ttm_bo_vm_close(struct vm_area_struct *vma);
464
465int ttm_bo_vm_access(struct vm_area_struct *vma, unsigned long addr,
466 void *buf, int len, int write);
467bool ttm_bo_delayed_delete(struct ttm_device *bdev, bool remove_all);
468
469vm_fault_t ttm_bo_vm_dummy_page(struct vm_fault *vmf, pgprot_t prot);
470
471#endif
1/**************************************************************************
2 *
3 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
4 * All Rights Reserved.
5 *
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:
13 *
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
16 * of the Software.
17 *
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.
25 *
26 **************************************************************************/
27/*
28 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
29 */
30
31#ifndef _TTM_BO_API_H_
32#define _TTM_BO_API_H_
33
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>
40#include <linux/mm.h>
41#include <linux/bitmap.h>
42#include <linux/reservation.h>
43
44struct ttm_bo_device;
45
46struct drm_mm_node;
47
48
49/**
50 * struct ttm_placement
51 *
52 * @fpfn: first valid page frame number to put the object
53 * @lpfn: last valid page frame number to put the object
54 * @num_placement: number of preferred placements
55 * @placement: preferred placements
56 * @num_busy_placement: number of preferred placements when need to evict buffer
57 * @busy_placement: preferred placements when need to evict buffer
58 *
59 * Structure indicating the placement you request for an object.
60 */
61struct ttm_placement {
62 unsigned fpfn;
63 unsigned lpfn;
64 unsigned num_placement;
65 const uint32_t *placement;
66 unsigned num_busy_placement;
67 const uint32_t *busy_placement;
68};
69
70/**
71 * struct ttm_bus_placement
72 *
73 * @addr: mapped virtual address
74 * @base: bus base address
75 * @is_iomem: is this io memory ?
76 * @size: size in byte
77 * @offset: offset from the base address
78 * @io_reserved_vm: The VM system has a refcount in @io_reserved_count
79 * @io_reserved_count: Refcounting the numbers of callers to ttm_mem_io_reserve
80 *
81 * Structure indicating the bus placement of an object.
82 */
83struct ttm_bus_placement {
84 void *addr;
85 unsigned long base;
86 unsigned long size;
87 unsigned long offset;
88 bool is_iomem;
89 bool io_reserved_vm;
90 uint64_t io_reserved_count;
91};
92
93
94/**
95 * struct ttm_mem_reg
96 *
97 * @mm_node: Memory manager node.
98 * @size: Requested size of memory region.
99 * @num_pages: Actual size of memory region in pages.
100 * @page_alignment: Page alignment.
101 * @placement: Placement flags.
102 * @bus: Placement on io bus accessible to the CPU
103 *
104 * Structure indicating the placement and space resources used by a
105 * buffer object.
106 */
107
108struct ttm_mem_reg {
109 void *mm_node;
110 unsigned long start;
111 unsigned long size;
112 unsigned long num_pages;
113 uint32_t page_alignment;
114 uint32_t mem_type;
115 uint32_t placement;
116 struct ttm_bus_placement bus;
117};
118
119/**
120 * enum ttm_bo_type
121 *
122 * @ttm_bo_type_device: These are 'normal' buffers that can
123 * be mmapped by user space. Each of these bos occupy a slot in the
124 * device address space, that can be used for normal vm operations.
125 *
126 * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,
127 * but they cannot be accessed from user-space. For kernel-only use.
128 *
129 * @ttm_bo_type_sg: Buffer made from dmabuf sg table shared with another
130 * driver.
131 */
132
133enum ttm_bo_type {
134 ttm_bo_type_device,
135 ttm_bo_type_kernel,
136 ttm_bo_type_sg
137};
138
139struct ttm_tt;
140
141/**
142 * struct ttm_buffer_object
143 *
144 * @bdev: Pointer to the buffer object device structure.
145 * @type: The bo type.
146 * @destroy: Destruction function. If NULL, kfree is used.
147 * @num_pages: Actual number of pages.
148 * @acc_size: Accounted size for this object.
149 * @kref: Reference count of this buffer object. When this refcount reaches
150 * zero, the object is put on the delayed delete list.
151 * @list_kref: List reference count of this buffer object. This member is
152 * used to avoid destruction while the buffer object is still on a list.
153 * Lru lists may keep one refcount, the delayed delete list, and kref != 0
154 * keeps one refcount. When this refcount reaches zero,
155 * the object is destroyed.
156 * @mem: structure describing current placement.
157 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
158 * pinned in physical memory. If this behaviour is not desired, this member
159 * holds a pointer to a persistent shmem object.
160 * @ttm: TTM structure holding system pages.
161 * @evicted: Whether the object was evicted without user-space knowing.
162 * @cpu_writes: For synchronization. Number of cpu writers.
163 * @lru: List head for the lru list.
164 * @ddestroy: List head for the delayed destroy list.
165 * @swap: List head for swap LRU list.
166 * @sync_obj: Pointer to a synchronization object.
167 * @priv_flags: Flags describing buffer object internal state.
168 * @vma_node: Address space manager node.
169 * @offset: The current GPU offset, which can have different meanings
170 * depending on the memory type. For SYSTEM type memory, it should be 0.
171 * @cur_placement: Hint of current placement.
172 * @wu_mutex: Wait unreserved mutex.
173 *
174 * Base class for TTM buffer object, that deals with data placement and CPU
175 * mappings. GPU mappings are really up to the driver, but for simpler GPUs
176 * the driver can usually use the placement offset @offset directly as the
177 * GPU virtual address. For drivers implementing multiple
178 * GPU memory manager contexts, the driver should manage the address space
179 * in these contexts separately and use these objects to get the correct
180 * placement and caching for these GPU maps. This makes it possible to use
181 * these objects for even quite elaborate memory management schemes.
182 * The destroy member, the API visibility of this object makes it possible
183 * to derive driver specific types.
184 */
185
186struct ttm_buffer_object {
187 /**
188 * Members constant at init.
189 */
190
191 struct ttm_bo_global *glob;
192 struct ttm_bo_device *bdev;
193 enum ttm_bo_type type;
194 void (*destroy) (struct ttm_buffer_object *);
195 unsigned long num_pages;
196 size_t acc_size;
197
198 /**
199 * Members not needing protection.
200 */
201
202 struct kref kref;
203 struct kref list_kref;
204
205 /**
206 * Members protected by the bo::resv::reserved lock.
207 */
208
209 struct ttm_mem_reg mem;
210 struct file *persistent_swap_storage;
211 struct ttm_tt *ttm;
212 bool evicted;
213
214 /**
215 * Members protected by the bo::reserved lock only when written to.
216 */
217
218 atomic_t cpu_writers;
219
220 /**
221 * Members protected by the bdev::lru_lock.
222 */
223
224 struct list_head lru;
225 struct list_head ddestroy;
226 struct list_head swap;
227 struct list_head io_reserve_lru;
228
229 /**
230 * Members protected by struct buffer_object_device::fence_lock
231 * In addition, setting sync_obj to anything else
232 * than NULL requires bo::reserved to be held. This allows for
233 * checking NULL while reserved but not holding the mentioned lock.
234 */
235
236 void *sync_obj;
237 unsigned long priv_flags;
238
239 struct drm_vma_offset_node vma_node;
240
241 /**
242 * Special members that are protected by the reserve lock
243 * and the bo::lock when written to. Can be read with
244 * either of these locks held.
245 */
246
247 unsigned long offset;
248 uint32_t cur_placement;
249
250 struct sg_table *sg;
251
252 struct reservation_object *resv;
253 struct reservation_object ttm_resv;
254 struct mutex wu_mutex;
255};
256
257/**
258 * struct ttm_bo_kmap_obj
259 *
260 * @virtual: The current kernel virtual address.
261 * @page: The page when kmap'ing a single page.
262 * @bo_kmap_type: Type of bo_kmap.
263 *
264 * Object describing a kernel mapping. Since a TTM bo may be located
265 * in various memory types with various caching policies, the
266 * mapping can either be an ioremap, a vmap, a kmap or part of a
267 * premapped region.
268 */
269
270#define TTM_BO_MAP_IOMEM_MASK 0x80
271struct ttm_bo_kmap_obj {
272 void *virtual;
273 struct page *page;
274 enum {
275 ttm_bo_map_iomap = 1 | TTM_BO_MAP_IOMEM_MASK,
276 ttm_bo_map_vmap = 2,
277 ttm_bo_map_kmap = 3,
278 ttm_bo_map_premapped = 4 | TTM_BO_MAP_IOMEM_MASK,
279 } bo_kmap_type;
280 struct ttm_buffer_object *bo;
281};
282
283/**
284 * ttm_bo_reference - reference a struct ttm_buffer_object
285 *
286 * @bo: The buffer object.
287 *
288 * Returns a refcounted pointer to a buffer object.
289 */
290
291static inline struct ttm_buffer_object *
292ttm_bo_reference(struct ttm_buffer_object *bo)
293{
294 kref_get(&bo->kref);
295 return bo;
296}
297
298/**
299 * ttm_bo_wait - wait for buffer idle.
300 *
301 * @bo: The buffer object.
302 * @interruptible: Use interruptible wait.
303 * @no_wait: Return immediately if buffer is busy.
304 *
305 * This function must be called with the bo::mutex held, and makes
306 * sure any previous rendering to the buffer is completed.
307 * Note: It might be necessary to block validations before the
308 * wait by reserving the buffer.
309 * Returns -EBUSY if no_wait is true and the buffer is busy.
310 * Returns -ERESTARTSYS if interrupted by a signal.
311 */
312extern int ttm_bo_wait(struct ttm_buffer_object *bo, bool lazy,
313 bool interruptible, bool no_wait);
314/**
315 * ttm_bo_validate
316 *
317 * @bo: The buffer object.
318 * @placement: Proposed placement for the buffer object.
319 * @interruptible: Sleep interruptible if sleeping.
320 * @no_wait_gpu: Return immediately if the GPU is busy.
321 *
322 * Changes placement and caching policy of the buffer object
323 * according proposed placement.
324 * Returns
325 * -EINVAL on invalid proposed placement.
326 * -ENOMEM on out-of-memory condition.
327 * -EBUSY if no_wait is true and buffer busy.
328 * -ERESTARTSYS if interrupted by a signal.
329 */
330extern int ttm_bo_validate(struct ttm_buffer_object *bo,
331 struct ttm_placement *placement,
332 bool interruptible,
333 bool no_wait_gpu);
334
335/**
336 * ttm_bo_unref
337 *
338 * @bo: The buffer object.
339 *
340 * Unreference and clear a pointer to a buffer object.
341 */
342extern void ttm_bo_unref(struct ttm_buffer_object **bo);
343
344
345/**
346 * ttm_bo_list_ref_sub
347 *
348 * @bo: The buffer object.
349 * @count: The number of references with which to decrease @bo::list_kref;
350 * @never_free: The refcount should not reach zero with this operation.
351 *
352 * Release @count lru list references to this buffer object.
353 */
354extern void ttm_bo_list_ref_sub(struct ttm_buffer_object *bo, int count,
355 bool never_free);
356
357/**
358 * ttm_bo_add_to_lru
359 *
360 * @bo: The buffer object.
361 *
362 * Add this bo to the relevant mem type lru and, if it's backed by
363 * system pages (ttms) to the swap list.
364 * This function must be called with struct ttm_bo_global::lru_lock held, and
365 * is typically called immediately prior to unreserving a bo.
366 */
367extern void ttm_bo_add_to_lru(struct ttm_buffer_object *bo);
368
369/**
370 * ttm_bo_del_from_lru
371 *
372 * @bo: The buffer object.
373 *
374 * Remove this bo from all lru lists used to lookup and reserve an object.
375 * This function must be called with struct ttm_bo_global::lru_lock held,
376 * and is usually called just immediately after the bo has been reserved to
377 * avoid recursive reservation from lru lists.
378 */
379extern int ttm_bo_del_from_lru(struct ttm_buffer_object *bo);
380
381
382/**
383 * ttm_bo_lock_delayed_workqueue
384 *
385 * Prevent the delayed workqueue from running.
386 * Returns
387 * True if the workqueue was queued at the time
388 */
389extern int ttm_bo_lock_delayed_workqueue(struct ttm_bo_device *bdev);
390
391/**
392 * ttm_bo_unlock_delayed_workqueue
393 *
394 * Allows the delayed workqueue to run.
395 */
396extern void ttm_bo_unlock_delayed_workqueue(struct ttm_bo_device *bdev,
397 int resched);
398
399/**
400 * ttm_bo_synccpu_write_grab
401 *
402 * @bo: The buffer object:
403 * @no_wait: Return immediately if buffer is busy.
404 *
405 * Synchronizes a buffer object for CPU RW access. This means
406 * command submission that affects the buffer will return -EBUSY
407 * until ttm_bo_synccpu_write_release is called.
408 *
409 * Returns
410 * -EBUSY if the buffer is busy and no_wait is true.
411 * -ERESTARTSYS if interrupted by a signal.
412 */
413extern int
414ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait);
415
416/**
417 * ttm_bo_synccpu_write_release:
418 *
419 * @bo : The buffer object.
420 *
421 * Releases a synccpu lock.
422 */
423extern void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo);
424
425/**
426 * ttm_bo_acc_size
427 *
428 * @bdev: Pointer to a ttm_bo_device struct.
429 * @bo_size: size of the buffer object in byte.
430 * @struct_size: size of the structure holding buffer object datas
431 *
432 * Returns size to account for a buffer object
433 */
434size_t ttm_bo_acc_size(struct ttm_bo_device *bdev,
435 unsigned long bo_size,
436 unsigned struct_size);
437size_t ttm_bo_dma_acc_size(struct ttm_bo_device *bdev,
438 unsigned long bo_size,
439 unsigned struct_size);
440
441/**
442 * ttm_bo_init
443 *
444 * @bdev: Pointer to a ttm_bo_device struct.
445 * @bo: Pointer to a ttm_buffer_object to be initialized.
446 * @size: Requested size of buffer object.
447 * @type: Requested type of buffer object.
448 * @flags: Initial placement flags.
449 * @page_alignment: Data alignment in pages.
450 * @interruptible: If needing to sleep to wait for GPU resources,
451 * sleep interruptible.
452 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
453 * pinned in physical memory. If this behaviour is not desired, this member
454 * holds a pointer to a persistent shmem object. Typically, this would
455 * point to the shmem object backing a GEM object if TTM is used to back a
456 * GEM user interface.
457 * @acc_size: Accounted size for this object.
458 * @destroy: Destroy function. Use NULL for kfree().
459 *
460 * This function initializes a pre-allocated struct ttm_buffer_object.
461 * As this object may be part of a larger structure, this function,
462 * together with the @destroy function,
463 * enables driver-specific objects derived from a ttm_buffer_object.
464 * On successful return, the object kref and list_kref are set to 1.
465 * If a failure occurs, the function will call the @destroy function, or
466 * kfree() if @destroy is NULL. Thus, after a failure, dereferencing @bo is
467 * illegal and will likely cause memory corruption.
468 *
469 * Returns
470 * -ENOMEM: Out of memory.
471 * -EINVAL: Invalid placement flags.
472 * -ERESTARTSYS: Interrupted by signal while sleeping waiting for resources.
473 */
474
475extern int ttm_bo_init(struct ttm_bo_device *bdev,
476 struct ttm_buffer_object *bo,
477 unsigned long size,
478 enum ttm_bo_type type,
479 struct ttm_placement *placement,
480 uint32_t page_alignment,
481 bool interrubtible,
482 struct file *persistent_swap_storage,
483 size_t acc_size,
484 struct sg_table *sg,
485 void (*destroy) (struct ttm_buffer_object *));
486
487/**
488 * ttm_bo_synccpu_object_init
489 *
490 * @bdev: Pointer to a ttm_bo_device struct.
491 * @bo: Pointer to a ttm_buffer_object to be initialized.
492 * @size: Requested size of buffer object.
493 * @type: Requested type of buffer object.
494 * @flags: Initial placement flags.
495 * @page_alignment: Data alignment in pages.
496 * @interruptible: If needing to sleep while waiting for GPU resources,
497 * sleep interruptible.
498 * @persistent_swap_storage: Usually the swap storage is deleted for buffers
499 * pinned in physical memory. If this behaviour is not desired, this member
500 * holds a pointer to a persistent shmem object. Typically, this would
501 * point to the shmem object backing a GEM object if TTM is used to back a
502 * GEM user interface.
503 * @p_bo: On successful completion *p_bo points to the created object.
504 *
505 * This function allocates a ttm_buffer_object, and then calls ttm_bo_init
506 * on that object. The destroy function is set to kfree().
507 * Returns
508 * -ENOMEM: Out of memory.
509 * -EINVAL: Invalid placement flags.
510 * -ERESTARTSYS: Interrupted by signal while waiting for resources.
511 */
512
513extern int ttm_bo_create(struct ttm_bo_device *bdev,
514 unsigned long size,
515 enum ttm_bo_type type,
516 struct ttm_placement *placement,
517 uint32_t page_alignment,
518 bool interruptible,
519 struct file *persistent_swap_storage,
520 struct ttm_buffer_object **p_bo);
521
522/**
523 * ttm_bo_check_placement
524 *
525 * @bo: the buffer object.
526 * @placement: placements
527 *
528 * Performs minimal validity checking on an intended change of
529 * placement flags.
530 * Returns
531 * -EINVAL: Intended change is invalid or not allowed.
532 */
533extern int ttm_bo_check_placement(struct ttm_buffer_object *bo,
534 struct ttm_placement *placement);
535
536/**
537 * ttm_bo_init_mm
538 *
539 * @bdev: Pointer to a ttm_bo_device struct.
540 * @mem_type: The memory type.
541 * @p_size: size managed area in pages.
542 *
543 * Initialize a manager for a given memory type.
544 * Note: if part of driver firstopen, it must be protected from a
545 * potentially racing lastclose.
546 * Returns:
547 * -EINVAL: invalid size or memory type.
548 * -ENOMEM: Not enough memory.
549 * May also return driver-specified errors.
550 */
551
552extern int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type,
553 unsigned long p_size);
554/**
555 * ttm_bo_clean_mm
556 *
557 * @bdev: Pointer to a ttm_bo_device struct.
558 * @mem_type: The memory type.
559 *
560 * Take down a manager for a given memory type after first walking
561 * the LRU list to evict any buffers left alive.
562 *
563 * Normally, this function is part of lastclose() or unload(), and at that
564 * point there shouldn't be any buffers left created by user-space, since
565 * there should've been removed by the file descriptor release() method.
566 * However, before this function is run, make sure to signal all sync objects,
567 * and verify that the delayed delete queue is empty. The driver must also
568 * make sure that there are no NO_EVICT buffers present in this memory type
569 * when the call is made.
570 *
571 * If this function is part of a VT switch, the caller must make sure that
572 * there are no appications currently validating buffers before this
573 * function is called. The caller can do that by first taking the
574 * struct ttm_bo_device::ttm_lock in write mode.
575 *
576 * Returns:
577 * -EINVAL: invalid or uninitialized memory type.
578 * -EBUSY: There are still buffers left in this memory type.
579 */
580
581extern int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type);
582
583/**
584 * ttm_bo_evict_mm
585 *
586 * @bdev: Pointer to a ttm_bo_device struct.
587 * @mem_type: The memory type.
588 *
589 * Evicts all buffers on the lru list of the memory type.
590 * This is normally part of a VT switch or an
591 * out-of-memory-space-due-to-fragmentation handler.
592 * The caller must make sure that there are no other processes
593 * currently validating buffers, and can do that by taking the
594 * struct ttm_bo_device::ttm_lock in write mode.
595 *
596 * Returns:
597 * -EINVAL: Invalid or uninitialized memory type.
598 * -ERESTARTSYS: The call was interrupted by a signal while waiting to
599 * evict a buffer.
600 */
601
602extern int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type);
603
604/**
605 * ttm_kmap_obj_virtual
606 *
607 * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap.
608 * @is_iomem: Pointer to an integer that on return indicates 1 if the
609 * virtual map is io memory, 0 if normal memory.
610 *
611 * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap.
612 * If *is_iomem is 1 on return, the virtual address points to an io memory area,
613 * that should strictly be accessed by the iowriteXX() and similar functions.
614 */
615
616static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map,
617 bool *is_iomem)
618{
619 *is_iomem = !!(map->bo_kmap_type & TTM_BO_MAP_IOMEM_MASK);
620 return map->virtual;
621}
622
623/**
624 * ttm_bo_kmap
625 *
626 * @bo: The buffer object.
627 * @start_page: The first page to map.
628 * @num_pages: Number of pages to map.
629 * @map: pointer to a struct ttm_bo_kmap_obj representing the map.
630 *
631 * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the
632 * data in the buffer object. The ttm_kmap_obj_virtual function can then be
633 * used to obtain a virtual address to the data.
634 *
635 * Returns
636 * -ENOMEM: Out of memory.
637 * -EINVAL: Invalid range.
638 */
639
640extern int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
641 unsigned long num_pages, struct ttm_bo_kmap_obj *map);
642
643/**
644 * ttm_bo_kunmap
645 *
646 * @map: Object describing the map to unmap.
647 *
648 * Unmaps a kernel map set up by ttm_bo_kmap.
649 */
650
651extern void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
652
653/**
654 * ttm_fbdev_mmap - mmap fbdev memory backed by a ttm buffer object.
655 *
656 * @vma: vma as input from the fbdev mmap method.
657 * @bo: The bo backing the address space. The address space will
658 * have the same size as the bo, and start at offset 0.
659 *
660 * This function is intended to be called by the fbdev mmap method
661 * if the fbdev address space is to be backed by a bo.
662 */
663
664extern int ttm_fbdev_mmap(struct vm_area_struct *vma,
665 struct ttm_buffer_object *bo);
666
667/**
668 * ttm_bo_mmap - mmap out of the ttm device address space.
669 *
670 * @filp: filp as input from the mmap method.
671 * @vma: vma as input from the mmap method.
672 * @bdev: Pointer to the ttm_bo_device with the address space manager.
673 *
674 * This function is intended to be called by the device mmap method.
675 * if the device address space is to be backed by the bo manager.
676 */
677
678extern int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma,
679 struct ttm_bo_device *bdev);
680
681/**
682 * ttm_bo_io
683 *
684 * @bdev: Pointer to the struct ttm_bo_device.
685 * @filp: Pointer to the struct file attempting to read / write.
686 * @wbuf: User-space pointer to address of buffer to write. NULL on read.
687 * @rbuf: User-space pointer to address of buffer to read into.
688 * Null on write.
689 * @count: Number of bytes to read / write.
690 * @f_pos: Pointer to current file position.
691 * @write: 1 for read, 0 for write.
692 *
693 * This function implements read / write into ttm buffer objects, and is
694 * intended to
695 * be called from the fops::read and fops::write method.
696 * Returns:
697 * See man (2) write, man(2) read. In particular,
698 * the function may return -ERESTARTSYS if
699 * interrupted by a signal.
700 */
701
702extern ssize_t ttm_bo_io(struct ttm_bo_device *bdev, struct file *filp,
703 const char __user *wbuf, char __user *rbuf,
704 size_t count, loff_t *f_pos, bool write);
705
706extern void ttm_bo_swapout_all(struct ttm_bo_device *bdev);
707extern int ttm_bo_wait_unreserved(struct ttm_buffer_object *bo);
708#endif