drm: Add the TTM GPU memory manager subsystem.
[linux-2.6.git] / include / drm / ttm / ttm_memory.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 #ifndef TTM_MEMORY_H
29 #define TTM_MEMORY_H
30
31 #include <linux/workqueue.h>
32 #include <linux/spinlock.h>
33 #include <linux/wait.h>
34 #include <linux/errno.h>
35
36 /**
37  * struct ttm_mem_shrink - callback to shrink TTM memory usage.
38  *
39  * @do_shrink: The callback function.
40  *
41  * Arguments to the do_shrink functions are intended to be passed using
42  * inheritance. That is, the argument class derives from struct ttm_mem_srink,
43  * and can be accessed using container_of().
44  */
45
46 struct ttm_mem_shrink {
47         int (*do_shrink) (struct ttm_mem_shrink *);
48 };
49
50 /**
51  * struct ttm_mem_global - Global memory accounting structure.
52  *
53  * @shrink: A single callback to shrink TTM memory usage. Extend this
54  * to a linked list to be able to handle multiple callbacks when needed.
55  * @swap_queue: A workqueue to handle shrinking in low memory situations. We
56  * need a separate workqueue since it will spend a lot of time waiting
57  * for the GPU, and this will otherwise block other workqueue tasks(?)
58  * At this point we use only a single-threaded workqueue.
59  * @work: The workqueue callback for the shrink queue.
60  * @queue: Wait queue for processes suspended waiting for memory.
61  * @lock: Lock to protect the @shrink - and the memory accounting members,
62  * that is, essentially the whole structure with some exceptions.
63  * @emer_memory: Lowmem memory limit available for root.
64  * @max_memory: Lowmem memory limit available for non-root.
65  * @swap_limit: Lowmem memory limit where the shrink workqueue kicks in.
66  * @used_memory: Currently used lowmem memory.
67  * @used_total_memory: Currently used total (lowmem + highmem) memory.
68  * @total_memory_swap_limit: Total memory limit where the shrink workqueue
69  * kicks in.
70  * @max_total_memory: Total memory available to non-root processes.
71  * @emer_total_memory: Total memory available to root processes.
72  *
73  * Note that this structure is not per device. It should be global for all
74  * graphics devices.
75  */
76
77 struct ttm_mem_global {
78         struct ttm_mem_shrink *shrink;
79         struct workqueue_struct *swap_queue;
80         struct work_struct work;
81         wait_queue_head_t queue;
82         spinlock_t lock;
83         uint64_t emer_memory;
84         uint64_t max_memory;
85         uint64_t swap_limit;
86         uint64_t used_memory;
87         uint64_t used_total_memory;
88         uint64_t total_memory_swap_limit;
89         uint64_t max_total_memory;
90         uint64_t emer_total_memory;
91 };
92
93 /**
94  * ttm_mem_init_shrink - initialize a struct ttm_mem_shrink object
95  *
96  * @shrink: The object to initialize.
97  * @func: The callback function.
98  */
99
100 static inline void ttm_mem_init_shrink(struct ttm_mem_shrink *shrink,
101                                        int (*func) (struct ttm_mem_shrink *))
102 {
103         shrink->do_shrink = func;
104 }
105
106 /**
107  * ttm_mem_register_shrink - register a struct ttm_mem_shrink object.
108  *
109  * @glob: The struct ttm_mem_global object to register with.
110  * @shrink: An initialized struct ttm_mem_shrink object to register.
111  *
112  * Returns:
113  * -EBUSY: There's already a callback registered. (May change).
114  */
115
116 static inline int ttm_mem_register_shrink(struct ttm_mem_global *glob,
117                                           struct ttm_mem_shrink *shrink)
118 {
119         spin_lock(&glob->lock);
120         if (glob->shrink != NULL) {
121                 spin_unlock(&glob->lock);
122                 return -EBUSY;
123         }
124         glob->shrink = shrink;
125         spin_unlock(&glob->lock);
126         return 0;
127 }
128
129 /**
130  * ttm_mem_unregister_shrink - unregister a struct ttm_mem_shrink object.
131  *
132  * @glob: The struct ttm_mem_global object to unregister from.
133  * @shrink: A previously registert struct ttm_mem_shrink object.
134  *
135  */
136
137 static inline void ttm_mem_unregister_shrink(struct ttm_mem_global *glob,
138                                              struct ttm_mem_shrink *shrink)
139 {
140         spin_lock(&glob->lock);
141         BUG_ON(glob->shrink != shrink);
142         glob->shrink = NULL;
143         spin_unlock(&glob->lock);
144 }
145
146 extern int ttm_mem_global_init(struct ttm_mem_global *glob);
147 extern void ttm_mem_global_release(struct ttm_mem_global *glob);
148 extern int ttm_mem_global_alloc(struct ttm_mem_global *glob, uint64_t memory,
149                                 bool no_wait, bool interruptible, bool himem);
150 extern void ttm_mem_global_free(struct ttm_mem_global *glob,
151                                 uint64_t amount, bool himem);
152 extern size_t ttm_round_pot(size_t size);
153 #endif