1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun * Copyright (C) 2000 Takashi Iwai <tiwai@suse.de>
4*4882a593Smuzhiyun *
5*4882a593Smuzhiyun * Generic memory management routines for soundcard memory allocation
6*4882a593Smuzhiyun */
7*4882a593Smuzhiyun
8*4882a593Smuzhiyun #include <linux/mutex.h>
9*4882a593Smuzhiyun #include <linux/init.h>
10*4882a593Smuzhiyun #include <linux/slab.h>
11*4882a593Smuzhiyun #include <linux/module.h>
12*4882a593Smuzhiyun #include <sound/core.h>
13*4882a593Smuzhiyun #include <sound/util_mem.h>
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun MODULE_AUTHOR("Takashi Iwai");
16*4882a593Smuzhiyun MODULE_DESCRIPTION("Generic memory management routines for soundcard memory allocation");
17*4882a593Smuzhiyun MODULE_LICENSE("GPL");
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun #define get_memblk(p) list_entry(p, struct snd_util_memblk, list)
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun /*
22*4882a593Smuzhiyun * create a new memory manager
23*4882a593Smuzhiyun */
24*4882a593Smuzhiyun struct snd_util_memhdr *
snd_util_memhdr_new(int memsize)25*4882a593Smuzhiyun snd_util_memhdr_new(int memsize)
26*4882a593Smuzhiyun {
27*4882a593Smuzhiyun struct snd_util_memhdr *hdr;
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun hdr = kzalloc(sizeof(*hdr), GFP_KERNEL);
30*4882a593Smuzhiyun if (hdr == NULL)
31*4882a593Smuzhiyun return NULL;
32*4882a593Smuzhiyun hdr->size = memsize;
33*4882a593Smuzhiyun mutex_init(&hdr->block_mutex);
34*4882a593Smuzhiyun INIT_LIST_HEAD(&hdr->block);
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun return hdr;
37*4882a593Smuzhiyun }
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun /*
40*4882a593Smuzhiyun * free a memory manager
41*4882a593Smuzhiyun */
snd_util_memhdr_free(struct snd_util_memhdr * hdr)42*4882a593Smuzhiyun void snd_util_memhdr_free(struct snd_util_memhdr *hdr)
43*4882a593Smuzhiyun {
44*4882a593Smuzhiyun struct list_head *p;
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun if (!hdr)
47*4882a593Smuzhiyun return;
48*4882a593Smuzhiyun /* release all blocks */
49*4882a593Smuzhiyun while ((p = hdr->block.next) != &hdr->block) {
50*4882a593Smuzhiyun list_del(p);
51*4882a593Smuzhiyun kfree(get_memblk(p));
52*4882a593Smuzhiyun }
53*4882a593Smuzhiyun kfree(hdr);
54*4882a593Smuzhiyun }
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun /*
57*4882a593Smuzhiyun * allocate a memory block (without mutex)
58*4882a593Smuzhiyun */
59*4882a593Smuzhiyun struct snd_util_memblk *
__snd_util_mem_alloc(struct snd_util_memhdr * hdr,int size)60*4882a593Smuzhiyun __snd_util_mem_alloc(struct snd_util_memhdr *hdr, int size)
61*4882a593Smuzhiyun {
62*4882a593Smuzhiyun struct snd_util_memblk *blk;
63*4882a593Smuzhiyun unsigned int units, prev_offset;
64*4882a593Smuzhiyun struct list_head *p;
65*4882a593Smuzhiyun
66*4882a593Smuzhiyun if (snd_BUG_ON(!hdr || size <= 0))
67*4882a593Smuzhiyun return NULL;
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun /* word alignment */
70*4882a593Smuzhiyun units = size;
71*4882a593Smuzhiyun if (units & 1)
72*4882a593Smuzhiyun units++;
73*4882a593Smuzhiyun if (units > hdr->size)
74*4882a593Smuzhiyun return NULL;
75*4882a593Smuzhiyun
76*4882a593Smuzhiyun /* look for empty block */
77*4882a593Smuzhiyun prev_offset = 0;
78*4882a593Smuzhiyun list_for_each(p, &hdr->block) {
79*4882a593Smuzhiyun blk = get_memblk(p);
80*4882a593Smuzhiyun if (blk->offset - prev_offset >= units)
81*4882a593Smuzhiyun goto __found;
82*4882a593Smuzhiyun prev_offset = blk->offset + blk->size;
83*4882a593Smuzhiyun }
84*4882a593Smuzhiyun if (hdr->size - prev_offset < units)
85*4882a593Smuzhiyun return NULL;
86*4882a593Smuzhiyun
87*4882a593Smuzhiyun __found:
88*4882a593Smuzhiyun return __snd_util_memblk_new(hdr, units, p->prev);
89*4882a593Smuzhiyun }
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun
92*4882a593Smuzhiyun /*
93*4882a593Smuzhiyun * create a new memory block with the given size
94*4882a593Smuzhiyun * the block is linked next to prev
95*4882a593Smuzhiyun */
96*4882a593Smuzhiyun struct snd_util_memblk *
__snd_util_memblk_new(struct snd_util_memhdr * hdr,unsigned int units,struct list_head * prev)97*4882a593Smuzhiyun __snd_util_memblk_new(struct snd_util_memhdr *hdr, unsigned int units,
98*4882a593Smuzhiyun struct list_head *prev)
99*4882a593Smuzhiyun {
100*4882a593Smuzhiyun struct snd_util_memblk *blk;
101*4882a593Smuzhiyun
102*4882a593Smuzhiyun blk = kmalloc(sizeof(struct snd_util_memblk) + hdr->block_extra_size,
103*4882a593Smuzhiyun GFP_KERNEL);
104*4882a593Smuzhiyun if (blk == NULL)
105*4882a593Smuzhiyun return NULL;
106*4882a593Smuzhiyun
107*4882a593Smuzhiyun if (prev == &hdr->block)
108*4882a593Smuzhiyun blk->offset = 0;
109*4882a593Smuzhiyun else {
110*4882a593Smuzhiyun struct snd_util_memblk *p = get_memblk(prev);
111*4882a593Smuzhiyun blk->offset = p->offset + p->size;
112*4882a593Smuzhiyun }
113*4882a593Smuzhiyun blk->size = units;
114*4882a593Smuzhiyun list_add(&blk->list, prev);
115*4882a593Smuzhiyun hdr->nblocks++;
116*4882a593Smuzhiyun hdr->used += units;
117*4882a593Smuzhiyun return blk;
118*4882a593Smuzhiyun }
119*4882a593Smuzhiyun
120*4882a593Smuzhiyun
121*4882a593Smuzhiyun /*
122*4882a593Smuzhiyun * allocate a memory block (with mutex)
123*4882a593Smuzhiyun */
124*4882a593Smuzhiyun struct snd_util_memblk *
snd_util_mem_alloc(struct snd_util_memhdr * hdr,int size)125*4882a593Smuzhiyun snd_util_mem_alloc(struct snd_util_memhdr *hdr, int size)
126*4882a593Smuzhiyun {
127*4882a593Smuzhiyun struct snd_util_memblk *blk;
128*4882a593Smuzhiyun mutex_lock(&hdr->block_mutex);
129*4882a593Smuzhiyun blk = __snd_util_mem_alloc(hdr, size);
130*4882a593Smuzhiyun mutex_unlock(&hdr->block_mutex);
131*4882a593Smuzhiyun return blk;
132*4882a593Smuzhiyun }
133*4882a593Smuzhiyun
134*4882a593Smuzhiyun
135*4882a593Smuzhiyun /*
136*4882a593Smuzhiyun * remove the block from linked-list and free resource
137*4882a593Smuzhiyun * (without mutex)
138*4882a593Smuzhiyun */
139*4882a593Smuzhiyun void
__snd_util_mem_free(struct snd_util_memhdr * hdr,struct snd_util_memblk * blk)140*4882a593Smuzhiyun __snd_util_mem_free(struct snd_util_memhdr *hdr, struct snd_util_memblk *blk)
141*4882a593Smuzhiyun {
142*4882a593Smuzhiyun list_del(&blk->list);
143*4882a593Smuzhiyun hdr->nblocks--;
144*4882a593Smuzhiyun hdr->used -= blk->size;
145*4882a593Smuzhiyun kfree(blk);
146*4882a593Smuzhiyun }
147*4882a593Smuzhiyun
148*4882a593Smuzhiyun /*
149*4882a593Smuzhiyun * free a memory block (with mutex)
150*4882a593Smuzhiyun */
snd_util_mem_free(struct snd_util_memhdr * hdr,struct snd_util_memblk * blk)151*4882a593Smuzhiyun int snd_util_mem_free(struct snd_util_memhdr *hdr, struct snd_util_memblk *blk)
152*4882a593Smuzhiyun {
153*4882a593Smuzhiyun if (snd_BUG_ON(!hdr || !blk))
154*4882a593Smuzhiyun return -EINVAL;
155*4882a593Smuzhiyun
156*4882a593Smuzhiyun mutex_lock(&hdr->block_mutex);
157*4882a593Smuzhiyun __snd_util_mem_free(hdr, blk);
158*4882a593Smuzhiyun mutex_unlock(&hdr->block_mutex);
159*4882a593Smuzhiyun return 0;
160*4882a593Smuzhiyun }
161*4882a593Smuzhiyun
162*4882a593Smuzhiyun /*
163*4882a593Smuzhiyun * return available memory size
164*4882a593Smuzhiyun */
snd_util_mem_avail(struct snd_util_memhdr * hdr)165*4882a593Smuzhiyun int snd_util_mem_avail(struct snd_util_memhdr *hdr)
166*4882a593Smuzhiyun {
167*4882a593Smuzhiyun unsigned int size;
168*4882a593Smuzhiyun mutex_lock(&hdr->block_mutex);
169*4882a593Smuzhiyun size = hdr->size - hdr->used;
170*4882a593Smuzhiyun mutex_unlock(&hdr->block_mutex);
171*4882a593Smuzhiyun return size;
172*4882a593Smuzhiyun }
173*4882a593Smuzhiyun
174*4882a593Smuzhiyun
175*4882a593Smuzhiyun EXPORT_SYMBOL(snd_util_memhdr_new);
176*4882a593Smuzhiyun EXPORT_SYMBOL(snd_util_memhdr_free);
177*4882a593Smuzhiyun EXPORT_SYMBOL(snd_util_mem_alloc);
178*4882a593Smuzhiyun EXPORT_SYMBOL(snd_util_mem_free);
179*4882a593Smuzhiyun EXPORT_SYMBOL(snd_util_mem_avail);
180*4882a593Smuzhiyun EXPORT_SYMBOL(__snd_util_mem_alloc);
181*4882a593Smuzhiyun EXPORT_SYMBOL(__snd_util_mem_free);
182*4882a593Smuzhiyun EXPORT_SYMBOL(__snd_util_memblk_new);
183