xref: /linux/sound/core/memory.c (revision d67b569f5f620c0fb95d5212642746b7ba9d29e4)
1 /*
2  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
3  *
4  *  Memory allocation helpers.
5  *
6  *
7  *   This program is free software; you can redistribute it and/or modify
8  *   it under the terms of the GNU General Public License as published by
9  *   the Free Software Foundation; either version 2 of the License, or
10  *   (at your option) any later version.
11  *
12  *   This program is distributed in the hope that it will be useful,
13  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
14  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  *   GNU General Public License for more details.
16  *
17  *   You should have received a copy of the GNU General Public License
18  *   along with this program; if not, write to the Free Software
19  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
20  *
21  */
22 
23 #include <sound/driver.h>
24 #include <asm/io.h>
25 #include <asm/uaccess.h>
26 #include <linux/init.h>
27 #include <linux/slab.h>
28 #include <linux/time.h>
29 #include <linux/pci.h>
30 #include <sound/core.h>
31 #include <sound/info.h>
32 
33 /*
34  *  memory allocation helpers and debug routines
35  */
36 
37 #ifdef CONFIG_SND_DEBUG_MEMORY
38 
39 struct snd_alloc_track {
40 	unsigned long magic;
41 	void *caller;
42 	size_t size;
43 	struct list_head list;
44 	long data[0];
45 };
46 
47 #define snd_alloc_track_entry(obj) (struct snd_alloc_track *)((char*)obj - (unsigned long)((struct snd_alloc_track *)0)->data)
48 
49 static long snd_alloc_kmalloc;
50 static long snd_alloc_vmalloc;
51 static LIST_HEAD(snd_alloc_kmalloc_list);
52 static LIST_HEAD(snd_alloc_vmalloc_list);
53 static DEFINE_SPINLOCK(snd_alloc_kmalloc_lock);
54 static DEFINE_SPINLOCK(snd_alloc_vmalloc_lock);
55 #define KMALLOC_MAGIC 0x87654321
56 #define VMALLOC_MAGIC 0x87654320
57 static snd_info_entry_t *snd_memory_info_entry;
58 
59 void snd_memory_init(void)
60 {
61 	snd_alloc_kmalloc = 0;
62 	snd_alloc_vmalloc = 0;
63 }
64 
65 void snd_memory_done(void)
66 {
67 	struct list_head *head;
68 	struct snd_alloc_track *t;
69 
70 	if (snd_alloc_kmalloc > 0)
71 		snd_printk(KERN_ERR "Not freed snd_alloc_kmalloc = %li\n", snd_alloc_kmalloc);
72 	if (snd_alloc_vmalloc > 0)
73 		snd_printk(KERN_ERR "Not freed snd_alloc_vmalloc = %li\n", snd_alloc_vmalloc);
74 	list_for_each_prev(head, &snd_alloc_kmalloc_list) {
75 		t = list_entry(head, struct snd_alloc_track, list);
76 		if (t->magic != KMALLOC_MAGIC) {
77 			snd_printk(KERN_ERR "Corrupted kmalloc\n");
78 			break;
79 		}
80 		snd_printk(KERN_ERR "kmalloc(%ld) from %p not freed\n", (long) t->size, t->caller);
81 	}
82 	list_for_each_prev(head, &snd_alloc_vmalloc_list) {
83 		t = list_entry(head, struct snd_alloc_track, list);
84 		if (t->magic != VMALLOC_MAGIC) {
85 			snd_printk(KERN_ERR "Corrupted vmalloc\n");
86 			break;
87 		}
88 		snd_printk(KERN_ERR "vmalloc(%ld) from %p not freed\n", (long) t->size, t->caller);
89 	}
90 }
91 
92 static void *__snd_kmalloc(size_t size, int flags, void *caller)
93 {
94 	unsigned long cpu_flags;
95 	struct snd_alloc_track *t;
96 	void *ptr;
97 
98 	ptr = snd_wrapper_kmalloc(size + sizeof(struct snd_alloc_track), flags);
99 	if (ptr != NULL) {
100 		t = (struct snd_alloc_track *)ptr;
101 		t->magic = KMALLOC_MAGIC;
102 		t->caller = caller;
103 		spin_lock_irqsave(&snd_alloc_kmalloc_lock, cpu_flags);
104 		list_add_tail(&t->list, &snd_alloc_kmalloc_list);
105 		spin_unlock_irqrestore(&snd_alloc_kmalloc_lock, cpu_flags);
106 		t->size = size;
107 		snd_alloc_kmalloc += size;
108 		ptr = t->data;
109 	}
110 	return ptr;
111 }
112 
113 #define _snd_kmalloc(size, flags) __snd_kmalloc((size), (flags), __builtin_return_address(0));
114 void *snd_hidden_kmalloc(size_t size, int flags)
115 {
116 	return _snd_kmalloc(size, flags);
117 }
118 
119 void *snd_hidden_kcalloc(size_t n, size_t size, int flags)
120 {
121 	void *ret = NULL;
122 	if (n != 0 && size > INT_MAX / n)
123 		return ret;
124 	ret = _snd_kmalloc(n * size, flags);
125 	if (ret)
126 		memset(ret, 0, n * size);
127 	return ret;
128 }
129 
130 void snd_hidden_kfree(const void *obj)
131 {
132 	unsigned long flags;
133 	struct snd_alloc_track *t;
134 	if (obj == NULL)
135 		return;
136 	t = snd_alloc_track_entry(obj);
137 	if (t->magic != KMALLOC_MAGIC) {
138 		snd_printk(KERN_WARNING "bad kfree (called from %p)\n", __builtin_return_address(0));
139 		return;
140 	}
141 	spin_lock_irqsave(&snd_alloc_kmalloc_lock, flags);
142 	list_del(&t->list);
143 	spin_unlock_irqrestore(&snd_alloc_kmalloc_lock, flags);
144 	t->magic = 0;
145 	snd_alloc_kmalloc -= t->size;
146 	obj = t;
147 	snd_wrapper_kfree(obj);
148 }
149 
150 void *snd_hidden_vmalloc(unsigned long size)
151 {
152 	void *ptr;
153 	ptr = snd_wrapper_vmalloc(size + sizeof(struct snd_alloc_track));
154 	if (ptr) {
155 		struct snd_alloc_track *t = (struct snd_alloc_track *)ptr;
156 		t->magic = VMALLOC_MAGIC;
157 		t->caller = __builtin_return_address(0);
158 		spin_lock(&snd_alloc_vmalloc_lock);
159 		list_add_tail(&t->list, &snd_alloc_vmalloc_list);
160 		spin_unlock(&snd_alloc_vmalloc_lock);
161 		t->size = size;
162 		snd_alloc_vmalloc += size;
163 		ptr = t->data;
164 	}
165 	return ptr;
166 }
167 
168 void snd_hidden_vfree(void *obj)
169 {
170 	struct snd_alloc_track *t;
171 	if (obj == NULL)
172 		return;
173 	t = snd_alloc_track_entry(obj);
174 	if (t->magic != VMALLOC_MAGIC) {
175 		snd_printk(KERN_ERR "bad vfree (called from %p)\n", __builtin_return_address(0));
176 		return;
177 	}
178 	spin_lock(&snd_alloc_vmalloc_lock);
179 	list_del(&t->list);
180 	spin_unlock(&snd_alloc_vmalloc_lock);
181 	t->magic = 0;
182 	snd_alloc_vmalloc -= t->size;
183 	obj = t;
184 	snd_wrapper_vfree(obj);
185 }
186 
187 char *snd_hidden_kstrdup(const char *s, int flags)
188 {
189 	int len;
190 	char *buf;
191 
192 	if (!s) return NULL;
193 
194 	len = strlen(s) + 1;
195 	buf = _snd_kmalloc(len, flags);
196 	if (buf)
197 		memcpy(buf, s, len);
198 	return buf;
199 }
200 
201 static void snd_memory_info_read(snd_info_entry_t *entry, snd_info_buffer_t * buffer)
202 {
203 	snd_iprintf(buffer, "kmalloc: %li bytes\n", snd_alloc_kmalloc);
204 	snd_iprintf(buffer, "vmalloc: %li bytes\n", snd_alloc_vmalloc);
205 }
206 
207 int __init snd_memory_info_init(void)
208 {
209 	snd_info_entry_t *entry;
210 
211 	entry = snd_info_create_module_entry(THIS_MODULE, "meminfo", NULL);
212 	if (entry) {
213 		entry->c.text.read_size = 256;
214 		entry->c.text.read = snd_memory_info_read;
215 		if (snd_info_register(entry) < 0) {
216 			snd_info_free_entry(entry);
217 			entry = NULL;
218 		}
219 	}
220 	snd_memory_info_entry = entry;
221 	return 0;
222 }
223 
224 int __exit snd_memory_info_done(void)
225 {
226 	if (snd_memory_info_entry)
227 		snd_info_unregister(snd_memory_info_entry);
228 	return 0;
229 }
230 
231 #endif /* CONFIG_SND_DEBUG_MEMORY */
232 
233 /**
234  * copy_to_user_fromio - copy data from mmio-space to user-space
235  * @dst: the destination pointer on user-space
236  * @src: the source pointer on mmio
237  * @count: the data size to copy in bytes
238  *
239  * Copies the data from mmio-space to user-space.
240  *
241  * Returns zero if successful, or non-zero on failure.
242  */
243 int copy_to_user_fromio(void __user *dst, const volatile void __iomem *src, size_t count)
244 {
245 #if defined(__i386__) || defined(CONFIG_SPARC32)
246 	return copy_to_user(dst, (const void*)src, count) ? -EFAULT : 0;
247 #else
248 	char buf[256];
249 	while (count) {
250 		size_t c = count;
251 		if (c > sizeof(buf))
252 			c = sizeof(buf);
253 		memcpy_fromio(buf, (void __iomem *)src, c);
254 		if (copy_to_user(dst, buf, c))
255 			return -EFAULT;
256 		count -= c;
257 		dst += c;
258 		src += c;
259 	}
260 	return 0;
261 #endif
262 }
263 
264 /**
265  * copy_from_user_toio - copy data from user-space to mmio-space
266  * @dst: the destination pointer on mmio-space
267  * @src: the source pointer on user-space
268  * @count: the data size to copy in bytes
269  *
270  * Copies the data from user-space to mmio-space.
271  *
272  * Returns zero if successful, or non-zero on failure.
273  */
274 int copy_from_user_toio(volatile void __iomem *dst, const void __user *src, size_t count)
275 {
276 #if defined(__i386__) || defined(CONFIG_SPARC32)
277 	return copy_from_user((void*)dst, src, count) ? -EFAULT : 0;
278 #else
279 	char buf[256];
280 	while (count) {
281 		size_t c = count;
282 		if (c > sizeof(buf))
283 			c = sizeof(buf);
284 		if (copy_from_user(buf, src, c))
285 			return -EFAULT;
286 		memcpy_toio(dst, buf, c);
287 		count -= c;
288 		dst += c;
289 		src += c;
290 	}
291 	return 0;
292 #endif
293 }
294