Update Doxygen configuration & comments.
[platform/upstream/libdrm.git] / linux-core / drm_memory_debug.c
1 /**
2  * \file drm_memory_debug.c
3  * Memory management wrappers for DRM.
4  *
5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
6  * \author Gareth Hughes <gareth@valinux.com>
7  */
8
9 /*
10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
12  * All Rights Reserved.
13  *
14  * Permission is hereby granted, free of charge, to any person obtaining a
15  * copy of this software and associated documentation files (the "Software"),
16  * to deal in the Software without restriction, including without limitation
17  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
18  * and/or sell copies of the Software, and to permit persons to whom the
19  * Software is furnished to do so, subject to the following conditions:
20  *
21  * The above copyright notice and this permission notice (including the next
22  * paragraph) shall be included in all copies or substantial portions of the
23  * Software.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
28  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
29  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
30  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
31  * OTHER DEALINGS IN THE SOFTWARE.
32  */
33
34 #include <linux/config.h>
35 #include "drmP.h"
36
37 #ifdef DEBUG_MEMORY
38
39 typedef struct drm_mem_stats {
40         const char *name;
41         int succeed_count;
42         int free_count;
43         int fail_count;
44         unsigned long bytes_allocated;
45         unsigned long bytes_freed;
46 } drm_mem_stats_t;
47
48 static spinlock_t drm_mem_lock = SPIN_LOCK_UNLOCKED;
49 static unsigned long drm_ram_available = 0;     /* In pages */
50 static unsigned long drm_ram_used = 0;
51 static drm_mem_stats_t drm_mem_stats[] = {
52         [DRM_MEM_DMA] = {"dmabufs"},
53         [DRM_MEM_SAREA] = {"sareas"},
54         [DRM_MEM_DRIVER] = {"driver"},
55         [DRM_MEM_MAGIC] = {"magic"},
56         [DRM_MEM_IOCTLS] = {"ioctltab"},
57         [DRM_MEM_MAPS] = {"maplist"},
58         [DRM_MEM_VMAS] = {"vmalist"},
59         [DRM_MEM_BUFS] = {"buflist"},
60         [DRM_MEM_SEGS] = {"seglist"},
61         [DRM_MEM_PAGES] = {"pagelist"},
62         [DRM_MEM_FILES] = {"files"},
63         [DRM_MEM_QUEUES] = {"queues"},
64         [DRM_MEM_CMDS] = {"commands"},
65         [DRM_MEM_MAPPINGS] = {"mappings"},
66         [DRM_MEM_BUFLISTS] = {"buflists"},
67         [DRM_MEM_AGPLISTS] = {"agplist"},
68         [DRM_MEM_SGLISTS] = {"sglist"},
69         [DRM_MEM_TOTALAGP] = {"totalagp"},
70         [DRM_MEM_BOUNDAGP] = {"boundagp"},
71         [DRM_MEM_CTXBITMAP] = {"ctxbitmap"},
72         [DRM_MEM_CTXLIST] = {"ctxlist"},
73         [DRM_MEM_STUB] = {"stub"},
74         {NULL, 0,}              /* Last entry must be null */
75 };
76
77 void drm_mem_init(void)
78 {
79         drm_mem_stats_t *mem;
80         struct sysinfo si;
81
82         for (mem = drm_mem_stats; mem->name; ++mem) {
83                 mem->succeed_count = 0;
84                 mem->free_count = 0;
85                 mem->fail_count = 0;
86                 mem->bytes_allocated = 0;
87                 mem->bytes_freed = 0;
88         }
89
90         si_meminfo(&si);
91         drm_ram_available = si.totalram;
92         drm_ram_used = 0;
93 }
94
95 /* drm_mem_info is called whenever a process reads /dev/drm/mem. */
96
97 static int drm__mem_info(char *buf, char **start, off_t offset,
98                          int request, int *eof, void *data)
99 {
100         drm_mem_stats_t *pt;
101         int len = 0;
102
103         if (offset > DRM_PROC_LIMIT) {
104                 *eof = 1;
105                 return 0;
106         }
107
108         *eof = 0;
109         *start = &buf[offset];
110
111         DRM_PROC_PRINT("                  total counts                  "
112                        " |    outstanding  \n");
113         DRM_PROC_PRINT("type       alloc freed fail     bytes      freed"
114                        " | allocs      bytes\n\n");
115         DRM_PROC_PRINT("%-9.9s %5d %5d %4d %10lu kB         |\n",
116                        "system", 0, 0, 0,
117                        drm_ram_available << (PAGE_SHIFT - 10));
118         DRM_PROC_PRINT("%-9.9s %5d %5d %4d %10lu kB         |\n",
119                        "locked", 0, 0, 0, drm_ram_used >> 10);
120         DRM_PROC_PRINT("\n");
121         for (pt = drm_mem_stats; pt->name; pt++) {
122                 DRM_PROC_PRINT("%-9.9s %5d %5d %4d %10lu %10lu | %6d %10ld\n",
123                                pt->name,
124                                pt->succeed_count,
125                                pt->free_count,
126                                pt->fail_count,
127                                pt->bytes_allocated,
128                                pt->bytes_freed,
129                                pt->succeed_count - pt->free_count,
130                                (long)pt->bytes_allocated
131                                - (long)pt->bytes_freed);
132         }
133
134         if (len > request + offset)
135                 return request;
136         *eof = 1;
137         return len - offset;
138 }
139
140 int drm_mem_info(char *buf, char **start, off_t offset,
141                  int len, int *eof, void *data)
142 {
143         int ret;
144
145         spin_lock(&drm_mem_lock);
146         ret = drm__mem_info(buf, start, offset, len, eof, data);
147         spin_unlock(&drm_mem_lock);
148         return ret;
149 }
150
151 void *drm_alloc(size_t size, int area)
152 {
153         void *pt;
154
155         if (!size) {
156                 DRM_MEM_ERROR(area, "Allocating 0 bytes\n");
157                 return NULL;
158         }
159
160         if (!(pt = kmalloc(size, GFP_KERNEL))) {
161                 spin_lock(&drm_mem_lock);
162                 ++drm_mem_stats[area].fail_count;
163                 spin_unlock(&drm_mem_lock);
164                 return NULL;
165         }
166         spin_lock(&drm_mem_lock);
167         ++drm_mem_stats[area].succeed_count;
168         drm_mem_stats[area].bytes_allocated += size;
169         spin_unlock(&drm_mem_lock);
170         return pt;
171 }
172 EXPORT_SYMBOL(drm_alloc);
173
174 void *drm_calloc(size_t nmemb, size_t size, int area)
175 {
176         void *addr;
177
178         addr = drm_alloc(nmemb * size, area);
179         if (addr != NULL)
180                 memset((void *)addr, 0, size * nmemb);
181
182         return addr;
183 }
184 EXPORT_SYMBOL(drm_calloc);
185
186 void *drm_realloc(void *oldpt, size_t oldsize, size_t size, int area)
187 {
188         void *pt;
189
190         if (!(pt = drm_alloc(size, area)))
191                 return NULL;
192         if (oldpt && oldsize) {
193                 memcpy(pt, oldpt, oldsize);
194                 drm_free(oldpt, oldsize, area);
195         }
196         return pt;
197 }
198 EXPORT_SYMBOL(drm_realloc);
199
200 void drm_free(void *pt, size_t size, int area)
201 {
202         int alloc_count;
203         int free_count;
204
205         if (!pt)
206                 DRM_MEM_ERROR(area, "Attempt to free NULL pointer\n");
207         else
208                 kfree(pt);
209         spin_lock(&drm_mem_lock);
210         drm_mem_stats[area].bytes_freed += size;
211         free_count = ++drm_mem_stats[area].free_count;
212         alloc_count = drm_mem_stats[area].succeed_count;
213         spin_unlock(&drm_mem_lock);
214         if (free_count > alloc_count) {
215                 DRM_MEM_ERROR(area, "Excess frees: %d frees, %d allocs\n",
216                               free_count, alloc_count);
217         }
218 }
219 EXPORT_SYMBOL(drm_free);
220
221 unsigned long drm_alloc_pages(int order, int area)
222 {
223         unsigned long address;
224         unsigned long bytes = PAGE_SIZE << order;
225         unsigned long addr;
226         unsigned int sz;
227
228         spin_lock(&drm_mem_lock);
229         if ((drm_ram_used >> PAGE_SHIFT)
230             > (DRM_RAM_PERCENT * drm_ram_available) / 100) {
231                 spin_unlock(&drm_mem_lock);
232                 return 0;
233         }
234         spin_unlock(&drm_mem_lock);
235
236         address = __get_free_pages(GFP_KERNEL, order);
237         if (!address) {
238                 spin_lock(&drm_mem_lock);
239                 ++drm_mem_stats[area].fail_count;
240                 spin_unlock(&drm_mem_lock);
241                 return 0;
242         }
243         spin_lock(&drm_mem_lock);
244         ++drm_mem_stats[area].succeed_count;
245         drm_mem_stats[area].bytes_allocated += bytes;
246         drm_ram_used += bytes;
247         spin_unlock(&drm_mem_lock);
248
249         /* Zero outside the lock */
250         memset((void *)address, 0, bytes);
251
252         /* Reserve */
253         for (addr = address, sz = bytes;
254              sz > 0; addr += PAGE_SIZE, sz -= PAGE_SIZE) {
255                 SetPageReserved(virt_to_page(addr));
256         }
257
258         return address;
259 }
260
261 void drm_free_pages(unsigned long address, int order, int area)
262 {
263         unsigned long bytes = PAGE_SIZE << order;
264         int alloc_count;
265         int free_count;
266         unsigned long addr;
267         unsigned int sz;
268
269         if (!address) {
270                 DRM_MEM_ERROR(area, "Attempt to free address 0\n");
271         } else {
272                 /* Unreserve */
273                 for (addr = address, sz = bytes;
274                      sz > 0; addr += PAGE_SIZE, sz -= PAGE_SIZE) {
275                         ClearPageReserved(virt_to_page(addr));
276                 }
277                 free_pages(address, order);
278         }
279
280         spin_lock(&drm_mem_lock);
281         free_count = ++drm_mem_stats[area].free_count;
282         alloc_count = drm_mem_stats[area].succeed_count;
283         drm_mem_stats[area].bytes_freed += bytes;
284         drm_ram_used -= bytes;
285         spin_unlock(&drm_mem_lock);
286         if (free_count > alloc_count) {
287                 DRM_MEM_ERROR(area,
288                               "Excess frees: %d frees, %d allocs\n",
289                               free_count, alloc_count);
290         }
291 }
292
293 void *drm_ioremap(unsigned long offset, unsigned long size, drm_device_t * dev)
294 {
295         void *pt;
296
297         if (!size) {
298                 DRM_MEM_ERROR(DRM_MEM_MAPPINGS,
299                               "Mapping 0 bytes at 0x%08lx\n", offset);
300                 return NULL;
301         }
302
303         if (!(pt = drm_ioremap(offset, size, dev))) {
304                 spin_lock(&drm_mem_lock);
305                 ++drm_mem_stats[DRM_MEM_MAPPINGS].fail_count;
306                 spin_unlock(&drm_mem_lock);
307                 return NULL;
308         }
309         spin_lock(&drm_mem_lock);
310         ++drm_mem_stats[DRM_MEM_MAPPINGS].succeed_count;
311         drm_mem_stats[DRM_MEM_MAPPINGS].bytes_allocated += size;
312         spin_unlock(&drm_mem_lock);
313         return pt;
314 }
315 EXPORT_SYMBOL(drm_ioremap);
316
317 void *drm_ioremap_nocache(unsigned long offset, unsigned long size,
318                           drm_device_t * dev)
319 {
320         void *pt;
321
322         if (!size) {
323                 DRM_MEM_ERROR(DRM_MEM_MAPPINGS,
324                               "Mapping 0 bytes at 0x%08lx\n", offset);
325                 return NULL;
326         }
327
328         if (!(pt = drm_ioremap_nocache(offset, size, dev))) {
329                 spin_lock(&drm_mem_lock);
330                 ++drm_mem_stats[DRM_MEM_MAPPINGS].fail_count;
331                 spin_unlock(&drm_mem_lock);
332                 return NULL;
333         }
334         spin_lock(&drm_mem_lock);
335         ++drm_mem_stats[DRM_MEM_MAPPINGS].succeed_count;
336         drm_mem_stats[DRM_MEM_MAPPINGS].bytes_allocated += size;
337         spin_unlock(&drm_mem_lock);
338         return pt;
339 }
340 EXPORT_SYMBOL(drm_ioremap_nocache);
341
342 void drm_ioremapfree(void *pt, unsigned long size, drm_device_t * dev)
343 {
344         int alloc_count;
345         int free_count;
346
347         if (!pt)
348                 DRM_MEM_ERROR(DRM_MEM_MAPPINGS,
349                               "Attempt to free NULL pointer\n");
350         else
351                 drm_ioremapfree(pt, size, dev);
352
353         spin_lock(&drm_mem_lock);
354         drm_mem_stats[DRM_MEM_MAPPINGS].bytes_freed += size;
355         free_count = ++drm_mem_stats[DRM_MEM_MAPPINGS].free_count;
356         alloc_count = drm_mem_stats[DRM_MEM_MAPPINGS].succeed_count;
357         spin_unlock(&drm_mem_lock);
358         if (free_count > alloc_count) {
359                 DRM_MEM_ERROR(DRM_MEM_MAPPINGS,
360                               "Excess frees: %d frees, %d allocs\n",
361                               free_count, alloc_count);
362         }
363 }
364 EXPORT_SYMBOL(drm_ioremapfree);
365
366 #if __OS_HAS_AGP
367
368 DRM_AGP_MEM *drm_alloc_agp(int pages, u32 type)
369 {
370         DRM_AGP_MEM *handle;
371
372         if (!pages) {
373                 DRM_MEM_ERROR(DRM_MEM_TOTALAGP, "Allocating 0 pages\n");
374                 return NULL;
375         }
376
377         if ((handle = drm_agp_allocate_memory(pages, type))) {
378                 spin_lock(&drm_mem_lock);
379                 ++drm_mem_stats[DRM_MEM_TOTALAGP].succeed_count;
380                 drm_mem_stats[DRM_MEM_TOTALAGP].bytes_allocated
381                     += pages << PAGE_SHIFT;
382                 spin_unlock(&drm_mem_lock);
383                 return handle;
384         }
385         spin_lock(&drm_mem_lock);
386         ++drm_mem_stats[DRM_MEM_TOTALAGP].fail_count;
387         spin_unlock(&drm_mem_lock);
388         return NULL;
389 }
390
391 int drm_free_agp(DRM_AGP_MEM * handle, int pages)
392 {
393         int alloc_count;
394         int free_count;
395         int retval = -EINVAL;
396
397         if (!handle) {
398                 DRM_MEM_ERROR(DRM_MEM_TOTALAGP,
399                               "Attempt to free NULL AGP handle\n");
400                 return retval;
401         }
402
403         if (drm_agp_free_memory(handle)) {
404                 spin_lock(&drm_mem_lock);
405                 free_count = ++drm_mem_stats[DRM_MEM_TOTALAGP].free_count;
406                 alloc_count = drm_mem_stats[DRM_MEM_TOTALAGP].succeed_count;
407                 drm_mem_stats[DRM_MEM_TOTALAGP].bytes_freed
408                     += pages << PAGE_SHIFT;
409                 spin_unlock(&drm_mem_lock);
410                 if (free_count > alloc_count) {
411                         DRM_MEM_ERROR(DRM_MEM_TOTALAGP,
412                                       "Excess frees: %d frees, %d allocs\n",
413                                       free_count, alloc_count);
414                 }
415                 return 0;
416         }
417         return retval;
418 }
419
420 int drm_bind_agp(DRM_AGP_MEM * handle, unsigned int start)
421 {
422         int retcode = -EINVAL;
423
424         if (!handle) {
425                 DRM_MEM_ERROR(DRM_MEM_BOUNDAGP,
426                               "Attempt to bind NULL AGP handle\n");
427                 return retcode;
428         }
429
430         if (!(retcode = drm_agp_bind_memory(handle, start))) {
431                 spin_lock(&drm_mem_lock);
432                 ++drm_mem_stats[DRM_MEM_BOUNDAGP].succeed_count;
433                 drm_mem_stats[DRM_MEM_BOUNDAGP].bytes_allocated
434                     += handle->page_count << PAGE_SHIFT;
435                 spin_unlock(&drm_mem_lock);
436                 return retcode;
437         }
438         spin_lock(&drm_mem_lock);
439         ++drm_mem_stats[DRM_MEM_BOUNDAGP].fail_count;
440         spin_unlock(&drm_mem_lock);
441         return retcode;
442 }
443
444 int drm_unbind_agp(DRM_AGP_MEM * handle)
445 {
446         int alloc_count;
447         int free_count;
448         int retcode = -EINVAL;
449
450         if (!handle) {
451                 DRM_MEM_ERROR(DRM_MEM_BOUNDAGP,
452                               "Attempt to unbind NULL AGP handle\n");
453                 return retcode;
454         }
455
456         if ((retcode = drm_agp_unbind_memory(handle)))
457                 return retcode;
458         spin_lock(&drm_mem_lock);
459         free_count = ++drm_mem_stats[DRM_MEM_BOUNDAGP].free_count;
460         alloc_count = drm_mem_stats[DRM_MEM_BOUNDAGP].succeed_count;
461         drm_mem_stats[DRM_MEM_BOUNDAGP].bytes_freed
462             += handle->page_count << PAGE_SHIFT;
463         spin_unlock(&drm_mem_lock);
464         if (free_count > alloc_count) {
465                 DRM_MEM_ERROR(DRM_MEM_BOUNDAGP,
466                               "Excess frees: %d frees, %d allocs\n",
467                               free_count, alloc_count);
468         }
469         return retcode;
470 }
471
472 #endif
473 #endif