[SCSI] scsi_lib.c: use BUILD_BUG_ON
[linux-2.6] / drivers / char / drm / drm_sman.c
1 /**************************************************************************
2  *
3  * Copyright 2006 Tungsten Graphics, Inc., Bismarck., ND., 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 SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
18  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
19  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
20  * USE OR OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * The above copyright notice and this permission notice (including the
23  * next paragraph) shall be included in all copies or substantial portions
24  * of the Software.
25  *
26  *
27  **************************************************************************/
28 /*
29  * Simple memory manager interface that keeps track on allocate regions on a
30  * per "owner" basis. All regions associated with an "owner" can be released
31  * with a simple call. Typically if the "owner" exists. The owner is any
32  * "unsigned long" identifier. Can typically be a pointer to a file private
33  * struct or a context identifier.
34  *
35  * Authors:
36  * Thomas Hellström <thomas-at-tungstengraphics-dot-com>
37  */
38
39 #include "drm_sman.h"
40
41 typedef struct drm_owner_item {
42         drm_hash_item_t owner_hash;
43         struct list_head sman_list;
44         struct list_head mem_blocks;
45 } drm_owner_item_t;
46
47 void drm_sman_takedown(drm_sman_t * sman)
48 {
49         drm_ht_remove(&sman->user_hash_tab);
50         drm_ht_remove(&sman->owner_hash_tab);
51         if (sman->mm)
52                 drm_free(sman->mm, sman->num_managers * sizeof(*sman->mm),
53                          DRM_MEM_MM);
54 }
55
56 EXPORT_SYMBOL(drm_sman_takedown);
57
58 int
59 drm_sman_init(drm_sman_t * sman, unsigned int num_managers,
60               unsigned int user_order, unsigned int owner_order)
61 {
62         int ret = 0;
63
64         sman->mm = (drm_sman_mm_t *) drm_calloc(num_managers, sizeof(*sman->mm),
65                                                 DRM_MEM_MM);
66         if (!sman->mm) {
67                 ret = -ENOMEM;
68                 goto out;
69         }
70         sman->num_managers = num_managers;
71         INIT_LIST_HEAD(&sman->owner_items);
72         ret = drm_ht_create(&sman->owner_hash_tab, owner_order);
73         if (ret)
74                 goto out1;
75         ret = drm_ht_create(&sman->user_hash_tab, user_order);
76         if (!ret)
77                 goto out;
78
79         drm_ht_remove(&sman->owner_hash_tab);
80 out1:
81         drm_free(sman->mm, num_managers * sizeof(*sman->mm), DRM_MEM_MM);
82 out:
83         return ret;
84 }
85
86 EXPORT_SYMBOL(drm_sman_init);
87
88 static void *drm_sman_mm_allocate(void *private, unsigned long size,
89                                   unsigned alignment)
90 {
91         drm_mm_t *mm = (drm_mm_t *) private;
92         drm_mm_node_t *tmp;
93
94         tmp = drm_mm_search_free(mm, size, alignment, 1);
95         if (!tmp) {
96                 return NULL;
97         }
98         tmp = drm_mm_get_block(tmp, size, alignment);
99         return tmp;
100 }
101
102 static void drm_sman_mm_free(void *private, void *ref)
103 {
104         drm_mm_t *mm = (drm_mm_t *) private;
105         drm_mm_node_t *node = (drm_mm_node_t *) ref;
106
107         drm_mm_put_block(mm, node);
108 }
109
110 static void drm_sman_mm_destroy(void *private)
111 {
112         drm_mm_t *mm = (drm_mm_t *) private;
113         drm_mm_takedown(mm);
114         drm_free(mm, sizeof(*mm), DRM_MEM_MM);
115 }
116
117 static unsigned long drm_sman_mm_offset(void *private, void *ref)
118 {
119         drm_mm_node_t *node = (drm_mm_node_t *) ref;
120         return node->start;
121 }
122
123 int
124 drm_sman_set_range(drm_sman_t * sman, unsigned int manager,
125                    unsigned long start, unsigned long size)
126 {
127         drm_sman_mm_t *sman_mm;
128         drm_mm_t *mm;
129         int ret;
130
131         BUG_ON(manager >= sman->num_managers);
132
133         sman_mm = &sman->mm[manager];
134         mm = drm_calloc(1, sizeof(*mm), DRM_MEM_MM);
135         if (!mm) {
136                 return -ENOMEM;
137         }
138         sman_mm->private = mm;
139         ret = drm_mm_init(mm, start, size);
140
141         if (ret) {
142                 drm_free(mm, sizeof(*mm), DRM_MEM_MM);
143                 return ret;
144         }
145
146         sman_mm->allocate = drm_sman_mm_allocate;
147         sman_mm->free = drm_sman_mm_free;
148         sman_mm->destroy = drm_sman_mm_destroy;
149         sman_mm->offset = drm_sman_mm_offset;
150
151         return 0;
152 }
153
154 EXPORT_SYMBOL(drm_sman_set_range);
155
156 int
157 drm_sman_set_manager(drm_sman_t * sman, unsigned int manager,
158                      drm_sman_mm_t * allocator)
159 {
160         BUG_ON(manager >= sman->num_managers);
161         sman->mm[manager] = *allocator;
162
163         return 0;
164 }
165
166 static drm_owner_item_t *drm_sman_get_owner_item(drm_sman_t * sman,
167                                                  unsigned long owner)
168 {
169         int ret;
170         drm_hash_item_t *owner_hash_item;
171         drm_owner_item_t *owner_item;
172
173         ret = drm_ht_find_item(&sman->owner_hash_tab, owner, &owner_hash_item);
174         if (!ret) {
175                 return drm_hash_entry(owner_hash_item, drm_owner_item_t,
176                                       owner_hash);
177         }
178
179         owner_item = drm_calloc(1, sizeof(*owner_item), DRM_MEM_MM);
180         if (!owner_item)
181                 goto out;
182
183         INIT_LIST_HEAD(&owner_item->mem_blocks);
184         owner_item->owner_hash.key = owner;
185         if (drm_ht_insert_item(&sman->owner_hash_tab, &owner_item->owner_hash))
186                 goto out1;
187
188         list_add_tail(&owner_item->sman_list, &sman->owner_items);
189         return owner_item;
190
191 out1:
192         drm_free(owner_item, sizeof(*owner_item), DRM_MEM_MM);
193 out:
194         return NULL;
195 }
196
197 drm_memblock_item_t *drm_sman_alloc(drm_sman_t *sman, unsigned int manager,
198                                     unsigned long size, unsigned alignment,
199                                     unsigned long owner)
200 {
201         void *tmp;
202         drm_sman_mm_t *sman_mm;
203         drm_owner_item_t *owner_item;
204         drm_memblock_item_t *memblock;
205
206         BUG_ON(manager >= sman->num_managers);
207
208         sman_mm = &sman->mm[manager];
209         tmp = sman_mm->allocate(sman_mm->private, size, alignment);
210
211         if (!tmp) {
212                 return NULL;
213         }
214
215         memblock = drm_calloc(1, sizeof(*memblock), DRM_MEM_MM);
216
217         if (!memblock)
218                 goto out;
219
220         memblock->mm_info = tmp;
221         memblock->mm = sman_mm;
222         memblock->sman = sman;
223
224         if (drm_ht_just_insert_please
225             (&sman->user_hash_tab, &memblock->user_hash,
226              (unsigned long)memblock, 32, 0, 0))
227                 goto out1;
228
229         owner_item = drm_sman_get_owner_item(sman, owner);
230         if (!owner_item)
231                 goto out2;
232
233         list_add_tail(&memblock->owner_list, &owner_item->mem_blocks);
234
235         return memblock;
236
237 out2:
238         drm_ht_remove_item(&sman->user_hash_tab, &memblock->user_hash);
239 out1:
240         drm_free(memblock, sizeof(*memblock), DRM_MEM_MM);
241 out:
242         sman_mm->free(sman_mm->private, tmp);
243
244         return NULL;
245 }
246
247 EXPORT_SYMBOL(drm_sman_alloc);
248
249 static void drm_sman_free(drm_memblock_item_t *item)
250 {
251         drm_sman_t *sman = item->sman;
252
253         list_del(&item->owner_list);
254         drm_ht_remove_item(&sman->user_hash_tab, &item->user_hash);
255         item->mm->free(item->mm->private, item->mm_info);
256         drm_free(item, sizeof(*item), DRM_MEM_MM);
257 }
258
259 int drm_sman_free_key(drm_sman_t *sman, unsigned int key)
260 {
261         drm_hash_item_t *hash_item;
262         drm_memblock_item_t *memblock_item;
263
264         if (drm_ht_find_item(&sman->user_hash_tab, key, &hash_item))
265                 return -EINVAL;
266
267         memblock_item = drm_hash_entry(hash_item, drm_memblock_item_t, user_hash);
268         drm_sman_free(memblock_item);
269         return 0;
270 }
271
272 EXPORT_SYMBOL(drm_sman_free_key);
273
274 static void drm_sman_remove_owner(drm_sman_t *sman,
275                                   drm_owner_item_t *owner_item)
276 {
277         list_del(&owner_item->sman_list);
278         drm_ht_remove_item(&sman->owner_hash_tab, &owner_item->owner_hash);
279         drm_free(owner_item, sizeof(*owner_item), DRM_MEM_MM);
280 }
281
282 int drm_sman_owner_clean(drm_sman_t *sman, unsigned long owner)
283 {
284
285         drm_hash_item_t *hash_item;
286         drm_owner_item_t *owner_item;
287
288         if (drm_ht_find_item(&sman->owner_hash_tab, owner, &hash_item)) {
289                 return -1;
290         }
291
292         owner_item = drm_hash_entry(hash_item, drm_owner_item_t, owner_hash);
293         if (owner_item->mem_blocks.next == &owner_item->mem_blocks) {
294                 drm_sman_remove_owner(sman, owner_item);
295                 return -1;
296         }
297
298         return 0;
299 }
300
301 EXPORT_SYMBOL(drm_sman_owner_clean);
302
303 static void drm_sman_do_owner_cleanup(drm_sman_t *sman,
304                                       drm_owner_item_t *owner_item)
305 {
306         drm_memblock_item_t *entry, *next;
307
308         list_for_each_entry_safe(entry, next, &owner_item->mem_blocks,
309                                  owner_list) {
310                 drm_sman_free(entry);
311         }
312         drm_sman_remove_owner(sman, owner_item);
313 }
314
315 void drm_sman_owner_cleanup(drm_sman_t *sman, unsigned long owner)
316 {
317
318         drm_hash_item_t *hash_item;
319         drm_owner_item_t *owner_item;
320
321         if (drm_ht_find_item(&sman->owner_hash_tab, owner, &hash_item)) {
322
323                 return;
324         }
325
326         owner_item = drm_hash_entry(hash_item, drm_owner_item_t, owner_hash);
327         drm_sman_do_owner_cleanup(sman, owner_item);
328 }
329
330 EXPORT_SYMBOL(drm_sman_owner_cleanup);
331
332 void drm_sman_cleanup(drm_sman_t *sman)
333 {
334         drm_owner_item_t *entry, *next;
335         unsigned int i;
336         drm_sman_mm_t *sman_mm;
337
338         list_for_each_entry_safe(entry, next, &sman->owner_items, sman_list) {
339                 drm_sman_do_owner_cleanup(sman, entry);
340         }
341         if (sman->mm) {
342                 for (i = 0; i < sman->num_managers; ++i) {
343                         sman_mm = &sman->mm[i];
344                         if (sman_mm->private) {
345                                 sman_mm->destroy(sman_mm->private);
346                                 sman_mm->private = NULL;
347                         }
348                 }
349         }
350 }
351
352 EXPORT_SYMBOL(drm_sman_cleanup);