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/bug.h> |
34 | #include <linux/wait.h> |
35 | #include <linux/errno.h> |
36 | #include <linux/kobject.h> |
37 | #include <linux/mm.h> |
38 | |
39 | struct page; |
40 | |
41 | /** |
42 | * struct ttm_mem_shrink - callback to shrink TTM memory usage. |
43 | * |
44 | * @do_shrink: The callback function. |
45 | * |
46 | * Arguments to the do_shrink functions are intended to be passed using |
47 | * inheritance. That is, the argument class derives from struct ttm_mem_shrink, |
48 | * and can be accessed using container_of(). |
49 | */ |
50 | |
51 | struct ttm_mem_shrink { |
52 | int (*do_shrink) (struct ttm_mem_shrink *); |
53 | }; |
54 | |
55 | /** |
56 | * struct ttm_mem_global - Global memory accounting structure. |
57 | * |
58 | * @shrink: A single callback to shrink TTM memory usage. Extend this |
59 | * to a linked list to be able to handle multiple callbacks when needed. |
60 | * @swap_queue: A workqueue to handle shrinking in low memory situations. We |
61 | * need a separate workqueue since it will spend a lot of time waiting |
62 | * for the GPU, and this will otherwise block other workqueue tasks(?) |
63 | * At this point we use only a single-threaded workqueue. |
64 | * @work: The workqueue callback for the shrink queue. |
65 | * @lock: Lock to protect the @shrink - and the memory accounting members, |
66 | * that is, essentially the whole structure with some exceptions. |
67 | * @zones: Array of pointers to accounting zones. |
68 | * @num_zones: Number of populated entries in the @zones array. |
69 | * @zone_kernel: Pointer to the kernel zone. |
70 | * @zone_highmem: Pointer to the highmem zone if there is one. |
71 | * @zone_dma32: Pointer to the dma32 zone if there is one. |
72 | * |
73 | * Note that this structure is not per device. It should be global for all |
74 | * graphics devices. |
75 | */ |
76 | |
77 | #define TTM_MEM_MAX_ZONES 2 |
78 | struct ttm_mem_zone; |
79 | struct ttm_mem_global { |
80 | #ifndef __NetBSD__ |
81 | struct kobject kobj; |
82 | #endif |
83 | struct ttm_mem_shrink *shrink; |
84 | struct workqueue_struct *swap_queue; |
85 | struct work_struct work; |
86 | spinlock_t lock; |
87 | struct ttm_mem_zone *zones[TTM_MEM_MAX_ZONES]; |
88 | unsigned int num_zones; |
89 | struct ttm_mem_zone *zone_kernel; |
90 | #ifdef CONFIG_HIGHMEM |
91 | struct ttm_mem_zone *zone_highmem; |
92 | #else |
93 | struct ttm_mem_zone *zone_dma32; |
94 | #endif |
95 | }; |
96 | |
97 | /** |
98 | * ttm_mem_init_shrink - initialize a struct ttm_mem_shrink object |
99 | * |
100 | * @shrink: The object to initialize. |
101 | * @func: The callback function. |
102 | */ |
103 | |
104 | static inline void ttm_mem_init_shrink(struct ttm_mem_shrink *shrink, |
105 | int (*func) (struct ttm_mem_shrink *)) |
106 | { |
107 | shrink->do_shrink = func; |
108 | } |
109 | |
110 | /** |
111 | * ttm_mem_register_shrink - register a struct ttm_mem_shrink object. |
112 | * |
113 | * @glob: The struct ttm_mem_global object to register with. |
114 | * @shrink: An initialized struct ttm_mem_shrink object to register. |
115 | * |
116 | * Returns: |
117 | * -EBUSY: There's already a callback registered. (May change). |
118 | */ |
119 | |
120 | static inline int ttm_mem_register_shrink(struct ttm_mem_global *glob, |
121 | struct ttm_mem_shrink *shrink) |
122 | { |
123 | spin_lock(&glob->lock); |
124 | if (glob->shrink != NULL) { |
125 | spin_unlock(&glob->lock); |
126 | return -EBUSY; |
127 | } |
128 | glob->shrink = shrink; |
129 | spin_unlock(&glob->lock); |
130 | return 0; |
131 | } |
132 | |
133 | /** |
134 | * ttm_mem_unregister_shrink - unregister a struct ttm_mem_shrink object. |
135 | * |
136 | * @glob: The struct ttm_mem_global object to unregister from. |
137 | * @shrink: A previously registert struct ttm_mem_shrink object. |
138 | * |
139 | */ |
140 | |
141 | static inline void ttm_mem_unregister_shrink(struct ttm_mem_global *glob, |
142 | struct ttm_mem_shrink *shrink) |
143 | { |
144 | spin_lock(&glob->lock); |
145 | BUG_ON(glob->shrink != shrink); |
146 | glob->shrink = NULL; |
147 | spin_unlock(&glob->lock); |
148 | } |
149 | |
150 | extern int ttm_mem_global_init(struct ttm_mem_global *glob); |
151 | extern void ttm_mem_global_release(struct ttm_mem_global *glob); |
152 | extern int ttm_mem_global_alloc(struct ttm_mem_global *glob, uint64_t memory, |
153 | bool no_wait, bool interruptible); |
154 | extern void ttm_mem_global_free(struct ttm_mem_global *glob, |
155 | uint64_t amount); |
156 | extern int ttm_mem_global_alloc_page(struct ttm_mem_global *glob, |
157 | struct page *page, |
158 | bool no_wait, bool interruptible); |
159 | extern void ttm_mem_global_free_page(struct ttm_mem_global *glob, |
160 | struct page *page); |
161 | extern size_t ttm_round_pot(size_t size); |
162 | #endif |
163 | |