drm: Add the TTM GPU memory manager subsystem.
[linux-2.6.git] / include / drm / ttm / ttm_bo_api.h
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_hashtab.h"
35 #include <linux/kref.h>
36 #include <linux/list.h>
37 #include <linux/wait.h>
38 #include <linux/mutex.h>
39 #include <linux/mm.h>
40 #include <linux/rbtree.h>
41 #include <linux/bitmap.h>
42
43 struct ttm_bo_device;
44
45 struct drm_mm_node;
46
47 /**
48  * struct ttm_mem_reg
49  *
50  * @mm_node: Memory manager node.
51  * @size: Requested size of memory region.
52  * @num_pages: Actual size of memory region in pages.
53  * @page_alignment: Page alignment.
54  * @placement: Placement flags.
55  *
56  * Structure indicating the placement and space resources used by a
57  * buffer object.
58  */
59
60 struct ttm_mem_reg {
61         struct drm_mm_node *mm_node;
62         unsigned long size;
63         unsigned long num_pages;
64         uint32_t page_alignment;
65         uint32_t mem_type;
66         uint32_t placement;
67 };
68
69 /**
70  * enum ttm_bo_type
71  *
72  * @ttm_bo_type_device: These are 'normal' buffers that can
73  * be mmapped by user space. Each of these bos occupy a slot in the
74  * device address space, that can be used for normal vm operations.
75  *
76  * @ttm_bo_type_user: These are user-space memory areas that are made
77  * available to the GPU by mapping the buffer pages into the GPU aperture
78  * space. These buffers cannot be mmaped from the device address space.
79  *
80  * @ttm_bo_type_kernel: These buffers are like ttm_bo_type_device buffers,
81  * but they cannot be accessed from user-space. For kernel-only use.
82  */
83
84 enum ttm_bo_type {
85         ttm_bo_type_device,
86         ttm_bo_type_user,
87         ttm_bo_type_kernel
88 };
89
90 struct ttm_tt;
91
92 /**
93  * struct ttm_buffer_object
94  *
95  * @bdev: Pointer to the buffer object device structure.
96  * @buffer_start: The virtual user-space start address of ttm_bo_type_user
97  * buffers.
98  * @type: The bo type.
99  * @destroy: Destruction function. If NULL, kfree is used.
100  * @num_pages: Actual number of pages.
101  * @addr_space_offset: Address space offset.
102  * @acc_size: Accounted size for this object.
103  * @kref: Reference count of this buffer object. When this refcount reaches
104  * zero, the object is put on the delayed delete list.
105  * @list_kref: List reference count of this buffer object. This member is
106  * used to avoid destruction while the buffer object is still on a list.
107  * Lru lists may keep one refcount, the delayed delete list, and kref != 0
108  * keeps one refcount. When this refcount reaches zero,
109  * the object is destroyed.
110  * @event_queue: Queue for processes waiting on buffer object status change.
111  * @lock: spinlock protecting mostly synchronization members.
112  * @proposed_placement: Proposed placement for the buffer. Changed only by the
113  * creator prior to validation as opposed to bo->mem.proposed_flags which is
114  * changed by the implementation prior to a buffer move if it wants to outsmart
115  * the buffer creator / user. This latter happens, for example, at eviction.
116  * @mem: structure describing current placement.
117  * @persistant_swap_storage: Usually the swap storage is deleted for buffers
118  * pinned in physical memory. If this behaviour is not desired, this member
119  * holds a pointer to a persistant shmem object.
120  * @ttm: TTM structure holding system pages.
121  * @evicted: Whether the object was evicted without user-space knowing.
122  * @cpu_writes: For synchronization. Number of cpu writers.
123  * @lru: List head for the lru list.
124  * @ddestroy: List head for the delayed destroy list.
125  * @swap: List head for swap LRU list.
126  * @val_seq: Sequence of the validation holding the @reserved lock.
127  * Used to avoid starvation when many processes compete to validate the
128  * buffer. This member is protected by the bo_device::lru_lock.
129  * @seq_valid: The value of @val_seq is valid. This value is protected by
130  * the bo_device::lru_lock.
131  * @reserved: Deadlock-free lock used for synchronization state transitions.
132  * @sync_obj_arg: Opaque argument to synchronization object function.
133  * @sync_obj: Pointer to a synchronization object.
134  * @priv_flags: Flags describing buffer object internal state.
135  * @vm_rb: Rb node for the vm rb tree.
136  * @vm_node: Address space manager node.
137  * @offset: The current GPU offset, which can have different meanings
138  * depending on the memory type. For SYSTEM type memory, it should be 0.
139  * @cur_placement: Hint of current placement.
140  *
141  * Base class for TTM buffer object, that deals with data placement and CPU
142  * mappings. GPU mappings are really up to the driver, but for simpler GPUs
143  * the driver can usually use the placement offset @offset directly as the
144  * GPU virtual address. For drivers implementing multiple
145  * GPU memory manager contexts, the driver should manage the address space
146  * in these contexts separately and use these objects to get the correct
147  * placement and caching for these GPU maps. This makes it possible to use
148  * these objects for even quite elaborate memory management schemes.
149  * The destroy member, the API visibility of this object makes it possible
150  * to derive driver specific types.
151  */
152
153 struct ttm_buffer_object {
154         /**
155          * Members constant at init.
156          */
157
158         struct ttm_bo_device *bdev;
159         unsigned long buffer_start;
160         enum ttm_bo_type type;
161         void (*destroy) (struct ttm_buffer_object *);
162         unsigned long num_pages;
163         uint64_t addr_space_offset;
164         size_t acc_size;
165
166         /**
167         * Members not needing protection.
168         */
169
170         struct kref kref;
171         struct kref list_kref;
172         wait_queue_head_t event_queue;
173         spinlock_t lock;
174
175         /**
176          * Members protected by the bo::reserved lock.
177          */
178
179         uint32_t proposed_placement;
180         struct ttm_mem_reg mem;
181         struct file *persistant_swap_storage;
182         struct ttm_tt *ttm;
183         bool evicted;
184
185         /**
186          * Members protected by the bo::reserved lock only when written to.
187          */
188
189         atomic_t cpu_writers;
190
191         /**
192          * Members protected by the bdev::lru_lock.
193          */
194
195         struct list_head lru;
196         struct list_head ddestroy;
197         struct list_head swap;
198         uint32_t val_seq;
199         bool seq_valid;
200
201         /**
202          * Members protected by the bdev::lru_lock
203          * only when written to.
204          */
205
206         atomic_t reserved;
207
208
209         /**
210          * Members protected by the bo::lock
211          */
212
213         void *sync_obj_arg;
214         void *sync_obj;
215         unsigned long priv_flags;
216
217         /**
218          * Members protected by the bdev::vm_lock
219          */
220
221         struct rb_node vm_rb;
222         struct drm_mm_node *vm_node;
223
224
225         /**
226          * Special members that are protected by the reserve lock
227          * and the bo::lock when written to. Can be read with
228          * either of these locks held.
229          */
230
231         unsigned long offset;
232         uint32_t cur_placement;
233 };
234
235 /**
236  * struct ttm_bo_kmap_obj
237  *
238  * @virtual: The current kernel virtual address.
239  * @page: The page when kmap'ing a single page.
240  * @bo_kmap_type: Type of bo_kmap.
241  *
242  * Object describing a kernel mapping. Since a TTM bo may be located
243  * in various memory types with various caching policies, the
244  * mapping can either be an ioremap, a vmap, a kmap or part of a
245  * premapped region.
246  */
247
248 struct ttm_bo_kmap_obj {
249         void *virtual;
250         struct page *page;
251         enum {
252                 ttm_bo_map_iomap,
253                 ttm_bo_map_vmap,
254                 ttm_bo_map_kmap,
255                 ttm_bo_map_premapped,
256         } bo_kmap_type;
257 };
258
259 /**
260  * ttm_bo_reference - reference a struct ttm_buffer_object
261  *
262  * @bo: The buffer object.
263  *
264  * Returns a refcounted pointer to a buffer object.
265  */
266
267 static inline struct ttm_buffer_object *
268 ttm_bo_reference(struct ttm_buffer_object *bo)
269 {
270         kref_get(&bo->kref);
271         return bo;
272 }
273
274 /**
275  * ttm_bo_wait - wait for buffer idle.
276  *
277  * @bo:  The buffer object.
278  * @interruptible:  Use interruptible wait.
279  * @no_wait:  Return immediately if buffer is busy.
280  *
281  * This function must be called with the bo::mutex held, and makes
282  * sure any previous rendering to the buffer is completed.
283  * Note: It might be necessary to block validations before the
284  * wait by reserving the buffer.
285  * Returns -EBUSY if no_wait is true and the buffer is busy.
286  * Returns -ERESTART if interrupted by a signal.
287  */
288 extern int ttm_bo_wait(struct ttm_buffer_object *bo, bool lazy,
289                        bool interruptible, bool no_wait);
290 /**
291  * ttm_buffer_object_validate
292  *
293  * @bo: The buffer object.
294  * @proposed_placement: Proposed_placement for the buffer object.
295  * @interruptible: Sleep interruptible if sleeping.
296  * @no_wait: Return immediately if the buffer is busy.
297  *
298  * Changes placement and caching policy of the buffer object
299  * according to bo::proposed_flags.
300  * Returns
301  * -EINVAL on invalid proposed_flags.
302  * -ENOMEM on out-of-memory condition.
303  * -EBUSY if no_wait is true and buffer busy.
304  * -ERESTART if interrupted by a signal.
305  */
306 extern int ttm_buffer_object_validate(struct ttm_buffer_object *bo,
307                                       uint32_t proposed_placement,
308                                       bool interruptible, bool no_wait);
309 /**
310  * ttm_bo_unref
311  *
312  * @bo: The buffer object.
313  *
314  * Unreference and clear a pointer to a buffer object.
315  */
316 extern void ttm_bo_unref(struct ttm_buffer_object **bo);
317
318 /**
319  * ttm_bo_synccpu_write_grab
320  *
321  * @bo: The buffer object:
322  * @no_wait: Return immediately if buffer is busy.
323  *
324  * Synchronizes a buffer object for CPU RW access. This means
325  * blocking command submission that affects the buffer and
326  * waiting for buffer idle. This lock is recursive.
327  * Returns
328  * -EBUSY if the buffer is busy and no_wait is true.
329  * -ERESTART if interrupted by a signal.
330  */
331
332 extern int
333 ttm_bo_synccpu_write_grab(struct ttm_buffer_object *bo, bool no_wait);
334 /**
335  * ttm_bo_synccpu_write_release:
336  *
337  * @bo : The buffer object.
338  *
339  * Releases a synccpu lock.
340  */
341 extern void ttm_bo_synccpu_write_release(struct ttm_buffer_object *bo);
342
343 /**
344  * ttm_buffer_object_init
345  *
346  * @bdev: Pointer to a ttm_bo_device struct.
347  * @bo: Pointer to a ttm_buffer_object to be initialized.
348  * @size: Requested size of buffer object.
349  * @type: Requested type of buffer object.
350  * @flags: Initial placement flags.
351  * @page_alignment: Data alignment in pages.
352  * @buffer_start: Virtual address of user space data backing a
353  * user buffer object.
354  * @interruptible: If needing to sleep to wait for GPU resources,
355  * sleep interruptible.
356  * @persistant_swap_storage: Usually the swap storage is deleted for buffers
357  * pinned in physical memory. If this behaviour is not desired, this member
358  * holds a pointer to a persistant shmem object. Typically, this would
359  * point to the shmem object backing a GEM object if TTM is used to back a
360  * GEM user interface.
361  * @acc_size: Accounted size for this object.
362  * @destroy: Destroy function. Use NULL for kfree().
363  *
364  * This function initializes a pre-allocated struct ttm_buffer_object.
365  * As this object may be part of a larger structure, this function,
366  * together with the @destroy function,
367  * enables driver-specific objects derived from a ttm_buffer_object.
368  * On successful return, the object kref and list_kref are set to 1.
369  * Returns
370  * -ENOMEM: Out of memory.
371  * -EINVAL: Invalid placement flags.
372  * -ERESTART: Interrupted by signal while sleeping waiting for resources.
373  */
374
375 extern int ttm_buffer_object_init(struct ttm_bo_device *bdev,
376                                   struct ttm_buffer_object *bo,
377                                   unsigned long size,
378                                   enum ttm_bo_type type,
379                                   uint32_t flags,
380                                   uint32_t page_alignment,
381                                   unsigned long buffer_start,
382                                   bool interrubtible,
383                                   struct file *persistant_swap_storage,
384                                   size_t acc_size,
385                                   void (*destroy) (struct ttm_buffer_object *));
386 /**
387  * ttm_bo_synccpu_object_init
388  *
389  * @bdev: Pointer to a ttm_bo_device struct.
390  * @bo: Pointer to a ttm_buffer_object to be initialized.
391  * @size: Requested size of buffer object.
392  * @type: Requested type of buffer object.
393  * @flags: Initial placement flags.
394  * @page_alignment: Data alignment in pages.
395  * @buffer_start: Virtual address of user space data backing a
396  * user buffer object.
397  * @interruptible: If needing to sleep while waiting for GPU resources,
398  * sleep interruptible.
399  * @persistant_swap_storage: Usually the swap storage is deleted for buffers
400  * pinned in physical memory. If this behaviour is not desired, this member
401  * holds a pointer to a persistant shmem object. Typically, this would
402  * point to the shmem object backing a GEM object if TTM is used to back a
403  * GEM user interface.
404  * @p_bo: On successful completion *p_bo points to the created object.
405  *
406  * This function allocates a ttm_buffer_object, and then calls
407  * ttm_buffer_object_init on that object.
408  * The destroy function is set to kfree().
409  * Returns
410  * -ENOMEM: Out of memory.
411  * -EINVAL: Invalid placement flags.
412  * -ERESTART: Interrupted by signal while waiting for resources.
413  */
414
415 extern int ttm_buffer_object_create(struct ttm_bo_device *bdev,
416                                     unsigned long size,
417                                     enum ttm_bo_type type,
418                                     uint32_t flags,
419                                     uint32_t page_alignment,
420                                     unsigned long buffer_start,
421                                     bool interruptible,
422                                     struct file *persistant_swap_storage,
423                                     struct ttm_buffer_object **p_bo);
424
425 /**
426  * ttm_bo_check_placement
427  *
428  * @bo: the buffer object.
429  * @set_flags: placement flags to set.
430  * @clr_flags: placement flags to clear.
431  *
432  * Performs minimal validity checking on an intended change of
433  * placement flags.
434  * Returns
435  * -EINVAL: Intended change is invalid or not allowed.
436  */
437
438 extern int ttm_bo_check_placement(struct ttm_buffer_object *bo,
439                                   uint32_t set_flags, uint32_t clr_flags);
440
441 /**
442  * ttm_bo_init_mm
443  *
444  * @bdev: Pointer to a ttm_bo_device struct.
445  * @mem_type: The memory type.
446  * @p_offset: offset for managed area in pages.
447  * @p_size: size managed area in pages.
448  *
449  * Initialize a manager for a given memory type.
450  * Note: if part of driver firstopen, it must be protected from a
451  * potentially racing lastclose.
452  * Returns:
453  * -EINVAL: invalid size or memory type.
454  * -ENOMEM: Not enough memory.
455  * May also return driver-specified errors.
456  */
457
458 extern int ttm_bo_init_mm(struct ttm_bo_device *bdev, unsigned type,
459                           unsigned long p_offset, unsigned long p_size);
460 /**
461  * ttm_bo_clean_mm
462  *
463  * @bdev: Pointer to a ttm_bo_device struct.
464  * @mem_type: The memory type.
465  *
466  * Take down a manager for a given memory type after first walking
467  * the LRU list to evict any buffers left alive.
468  *
469  * Normally, this function is part of lastclose() or unload(), and at that
470  * point there shouldn't be any buffers left created by user-space, since
471  * there should've been removed by the file descriptor release() method.
472  * However, before this function is run, make sure to signal all sync objects,
473  * and verify that the delayed delete queue is empty. The driver must also
474  * make sure that there are no NO_EVICT buffers present in this memory type
475  * when the call is made.
476  *
477  * If this function is part of a VT switch, the caller must make sure that
478  * there are no appications currently validating buffers before this
479  * function is called. The caller can do that by first taking the
480  * struct ttm_bo_device::ttm_lock in write mode.
481  *
482  * Returns:
483  * -EINVAL: invalid or uninitialized memory type.
484  * -EBUSY: There are still buffers left in this memory type.
485  */
486
487 extern int ttm_bo_clean_mm(struct ttm_bo_device *bdev, unsigned mem_type);
488
489 /**
490  * ttm_bo_evict_mm
491  *
492  * @bdev: Pointer to a ttm_bo_device struct.
493  * @mem_type: The memory type.
494  *
495  * Evicts all buffers on the lru list of the memory type.
496  * This is normally part of a VT switch or an
497  * out-of-memory-space-due-to-fragmentation handler.
498  * The caller must make sure that there are no other processes
499  * currently validating buffers, and can do that by taking the
500  * struct ttm_bo_device::ttm_lock in write mode.
501  *
502  * Returns:
503  * -EINVAL: Invalid or uninitialized memory type.
504  * -ERESTART: The call was interrupted by a signal while waiting to
505  * evict a buffer.
506  */
507
508 extern int ttm_bo_evict_mm(struct ttm_bo_device *bdev, unsigned mem_type);
509
510 /**
511  * ttm_kmap_obj_virtual
512  *
513  * @map: A struct ttm_bo_kmap_obj returned from ttm_bo_kmap.
514  * @is_iomem: Pointer to an integer that on return indicates 1 if the
515  * virtual map is io memory, 0 if normal memory.
516  *
517  * Returns the virtual address of a buffer object area mapped by ttm_bo_kmap.
518  * If *is_iomem is 1 on return, the virtual address points to an io memory area,
519  * that should strictly be accessed by the iowriteXX() and similar functions.
520  */
521
522 static inline void *ttm_kmap_obj_virtual(struct ttm_bo_kmap_obj *map,
523                                          bool *is_iomem)
524 {
525         *is_iomem = (map->bo_kmap_type == ttm_bo_map_iomap ||
526                      map->bo_kmap_type == ttm_bo_map_premapped);
527         return map->virtual;
528 }
529
530 /**
531  * ttm_bo_kmap
532  *
533  * @bo: The buffer object.
534  * @start_page: The first page to map.
535  * @num_pages: Number of pages to map.
536  * @map: pointer to a struct ttm_bo_kmap_obj representing the map.
537  *
538  * Sets up a kernel virtual mapping, using ioremap, vmap or kmap to the
539  * data in the buffer object. The ttm_kmap_obj_virtual function can then be
540  * used to obtain a virtual address to the data.
541  *
542  * Returns
543  * -ENOMEM: Out of memory.
544  * -EINVAL: Invalid range.
545  */
546
547 extern int ttm_bo_kmap(struct ttm_buffer_object *bo, unsigned long start_page,
548                        unsigned long num_pages, struct ttm_bo_kmap_obj *map);
549
550 /**
551  * ttm_bo_kunmap
552  *
553  * @map: Object describing the map to unmap.
554  *
555  * Unmaps a kernel map set up by ttm_bo_kmap.
556  */
557
558 extern void ttm_bo_kunmap(struct ttm_bo_kmap_obj *map);
559
560 #if 0
561 #endif
562
563 /**
564  * ttm_fbdev_mmap - mmap fbdev memory backed by a ttm buffer object.
565  *
566  * @vma:       vma as input from the fbdev mmap method.
567  * @bo:        The bo backing the address space. The address space will
568  * have the same size as the bo, and start at offset 0.
569  *
570  * This function is intended to be called by the fbdev mmap method
571  * if the fbdev address space is to be backed by a bo.
572  */
573
574 extern int ttm_fbdev_mmap(struct vm_area_struct *vma,
575                           struct ttm_buffer_object *bo);
576
577 /**
578  * ttm_bo_mmap - mmap out of the ttm device address space.
579  *
580  * @filp:      filp as input from the mmap method.
581  * @vma:       vma as input from the mmap method.
582  * @bdev:      Pointer to the ttm_bo_device with the address space manager.
583  *
584  * This function is intended to be called by the device mmap method.
585  * if the device address space is to be backed by the bo manager.
586  */
587
588 extern int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma,
589                        struct ttm_bo_device *bdev);
590
591 /**
592  * ttm_bo_io
593  *
594  * @bdev:      Pointer to the struct ttm_bo_device.
595  * @filp:      Pointer to the struct file attempting to read / write.
596  * @wbuf:      User-space pointer to address of buffer to write. NULL on read.
597  * @rbuf:      User-space pointer to address of buffer to read into.
598  * Null on write.
599  * @count:     Number of bytes to read / write.
600  * @f_pos:     Pointer to current file position.
601  * @write:     1 for read, 0 for write.
602  *
603  * This function implements read / write into ttm buffer objects, and is
604  * intended to
605  * be called from the fops::read and fops::write method.
606  * Returns:
607  * See man (2) write, man(2) read. In particular,
608  * the function may return -EINTR if
609  * interrupted by a signal.
610  */
611
612 extern ssize_t ttm_bo_io(struct ttm_bo_device *bdev, struct file *filp,
613                          const char __user *wbuf, char __user *rbuf,
614                          size_t count, loff_t *f_pos, bool write);
615
616 extern void ttm_bo_swapout_all(struct ttm_bo_device *bdev);
617
618 #endif