2 * ALSA sequencer Memory Manager
3 * Copyright (c) 1998 by Frank van de Pol <fvdpol@coil.demon.nl>
4 * Jaroslav Kysela <perex@perex.cz>
5 * 2000 by Takashi Iwai <tiwai@suse.de>
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.
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.
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
23 #include <linux/init.h>
24 #include <linux/export.h>
25 #include <linux/slab.h>
26 #include <linux/vmalloc.h>
27 #include <sound/core.h>
29 #include <sound/seq_kernel.h>
30 #include "seq_memory.h"
31 #include "seq_queue.h"
35 static inline int snd_seq_pool_available(struct snd_seq_pool *pool)
37 return pool->total_elements - atomic_read(&pool->counter);
40 static inline int snd_seq_output_ok(struct snd_seq_pool *pool)
42 return snd_seq_pool_available(pool) >= pool->room;
46 * Variable length event:
47 * The event like sysex uses variable length type.
48 * The external data may be stored in three different formats.
50 * This is the normal case.
51 * ext.data.len = length
52 * ext.data.ptr = buffer pointer
54 * When an event is generated via read(), the external data is
55 * kept in user space until expanded.
56 * ext.data.len = length | SNDRV_SEQ_EXT_USRPTR
57 * ext.data.ptr = userspace pointer
59 * When the variable length event is enqueued (in prioq or fifo),
60 * the external data is decomposed to several cells.
61 * ext.data.len = length | SNDRV_SEQ_EXT_CHAINED
62 * ext.data.ptr = the additiona cell head
63 * -> cell.next -> cell.next -> ..
68 * call dump function to expand external data.
71 static int get_var_len(const struct snd_seq_event *event)
73 if ((event->flags & SNDRV_SEQ_EVENT_LENGTH_MASK) != SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
76 return event->data.ext.len & ~SNDRV_SEQ_EXT_MASK;
79 int snd_seq_dump_var_event(const struct snd_seq_event *event,
80 snd_seq_dump_func_t func, void *private_data)
83 struct snd_seq_event_cell *cell;
85 if ((len = get_var_len(event)) <= 0)
88 if (event->data.ext.len & SNDRV_SEQ_EXT_USRPTR) {
90 char __user *curptr = (char __force __user *)event->data.ext.ptr;
92 int size = sizeof(buf);
95 if (copy_from_user(buf, curptr, size))
97 err = func(private_data, buf, size);
105 if (!(event->data.ext.len & SNDRV_SEQ_EXT_CHAINED))
106 return func(private_data, event->data.ext.ptr, len);
108 cell = (struct snd_seq_event_cell *)event->data.ext.ptr;
109 for (; len > 0 && cell; cell = cell->next) {
110 int size = sizeof(struct snd_seq_event);
113 err = func(private_data, &cell->event, size);
121 EXPORT_SYMBOL(snd_seq_dump_var_event);
126 * expand the variable length event to linear buffer space.
129 static int seq_copy_in_kernel(void *ptr, void *src, int size)
133 memcpy(*bufptr, src, size);
138 static int seq_copy_in_user(void *ptr, void *src, int size)
140 char __user **bufptr = ptr;
142 if (copy_to_user(*bufptr, src, size))
148 int snd_seq_expand_var_event(const struct snd_seq_event *event, int count, char *buf,
149 int in_kernel, int size_aligned)
154 if ((len = get_var_len(event)) < 0)
157 if (size_aligned > 0)
158 newlen = roundup(len, size_aligned);
162 if (event->data.ext.len & SNDRV_SEQ_EXT_USRPTR) {
165 if (copy_from_user(buf, (void __force __user *)event->data.ext.ptr, len))
169 err = snd_seq_dump_var_event(event,
170 in_kernel ? seq_copy_in_kernel : seq_copy_in_user,
172 return err < 0 ? err : newlen;
175 EXPORT_SYMBOL(snd_seq_expand_var_event);
178 * release this cell, free extended data if available
181 static inline void free_cell(struct snd_seq_pool *pool,
182 struct snd_seq_event_cell *cell)
184 cell->next = pool->free;
186 atomic_dec(&pool->counter);
189 void snd_seq_cell_free(struct snd_seq_event_cell * cell)
192 struct snd_seq_pool *pool;
194 if (snd_BUG_ON(!cell))
197 if (snd_BUG_ON(!pool))
200 spin_lock_irqsave(&pool->lock, flags);
201 free_cell(pool, cell);
202 if (snd_seq_ev_is_variable(&cell->event)) {
203 if (cell->event.data.ext.len & SNDRV_SEQ_EXT_CHAINED) {
204 struct snd_seq_event_cell *curp, *nextptr;
205 curp = cell->event.data.ext.ptr;
206 for (; curp; curp = nextptr) {
207 nextptr = curp->next;
208 curp->next = pool->free;
209 free_cell(pool, curp);
213 if (waitqueue_active(&pool->output_sleep)) {
214 /* has enough space now? */
215 if (snd_seq_output_ok(pool))
216 wake_up(&pool->output_sleep);
218 spin_unlock_irqrestore(&pool->lock, flags);
223 * allocate an event cell.
225 static int snd_seq_cell_alloc(struct snd_seq_pool *pool,
226 struct snd_seq_event_cell **cellp,
227 int nonblock, struct file *file,
228 struct mutex *mutexp)
230 struct snd_seq_event_cell *cell;
240 init_waitqueue_entry(&wait, current);
241 spin_lock_irqsave(&pool->lock, flags);
242 if (pool->ptr == NULL) { /* not initialized */
243 pr_debug("ALSA: seq: pool is not initialized\n");
247 while (pool->free == NULL && ! nonblock && ! pool->closing) {
249 set_current_state(TASK_INTERRUPTIBLE);
250 add_wait_queue(&pool->output_sleep, &wait);
251 spin_unlock_irq(&pool->lock);
253 mutex_unlock(mutexp);
257 spin_lock_irq(&pool->lock);
258 remove_wait_queue(&pool->output_sleep, &wait);
260 if (signal_pending(current)) {
265 if (pool->closing) { /* closing.. */
273 pool->free = cell->next;
274 atomic_inc(&pool->counter);
275 used = atomic_read(&pool->counter);
276 if (pool->max_used < used)
277 pool->max_used = used;
278 pool->event_alloc_success++;
279 /* clear cell pointers */
283 pool->event_alloc_failures++;
287 spin_unlock_irqrestore(&pool->lock, flags);
293 * duplicate the event to a cell.
294 * if the event has external data, the data is decomposed to additional
297 int snd_seq_event_dup(struct snd_seq_pool *pool, struct snd_seq_event *event,
298 struct snd_seq_event_cell **cellp, int nonblock,
299 struct file *file, struct mutex *mutexp)
303 struct snd_seq_event_cell *cell;
309 if (snd_seq_ev_is_variable(event)) {
310 extlen = event->data.ext.len & ~SNDRV_SEQ_EXT_MASK;
311 ncells = (extlen + sizeof(struct snd_seq_event) - 1) / sizeof(struct snd_seq_event);
313 if (ncells >= pool->total_elements)
316 err = snd_seq_cell_alloc(pool, &cell, nonblock, file, mutexp);
321 cell->event = *event;
324 if (snd_seq_ev_is_variable(event)) {
326 int is_chained = event->data.ext.len & SNDRV_SEQ_EXT_CHAINED;
327 int is_usrptr = event->data.ext.len & SNDRV_SEQ_EXT_USRPTR;
328 struct snd_seq_event_cell *src, *tmp, *tail;
331 cell->event.data.ext.len = extlen | SNDRV_SEQ_EXT_CHAINED;
332 cell->event.data.ext.ptr = NULL;
334 src = (struct snd_seq_event_cell *)event->data.ext.ptr;
335 buf = (char *)event->data.ext.ptr;
338 while (ncells-- > 0) {
339 int size = sizeof(struct snd_seq_event);
342 err = snd_seq_cell_alloc(pool, &tmp, nonblock, file,
346 if (cell->event.data.ext.ptr == NULL)
347 cell->event.data.ext.ptr = tmp;
352 if (is_chained && src) {
353 tmp->event = src->event;
355 } else if (is_usrptr) {
356 if (copy_from_user(&tmp->event, (char __force __user *)buf, size)) {
361 memcpy(&tmp->event, buf, size);
372 snd_seq_cell_free(cell);
378 int snd_seq_pool_poll_wait(struct snd_seq_pool *pool, struct file *file,
381 poll_wait(file, &pool->output_sleep, wait);
382 return snd_seq_output_ok(pool);
386 /* allocate room specified number of events */
387 int snd_seq_pool_init(struct snd_seq_pool *pool)
390 struct snd_seq_event_cell *cellptr;
393 if (snd_BUG_ON(!pool))
396 cellptr = vmalloc(sizeof(struct snd_seq_event_cell) * pool->size);
400 /* add new cells to the free cell list */
401 spin_lock_irqsave(&pool->lock, flags);
403 spin_unlock_irqrestore(&pool->lock, flags);
411 for (cell = 0; cell < pool->size; cell++) {
412 cellptr = pool->ptr + cell;
413 cellptr->pool = pool;
414 cellptr->next = pool->free;
415 pool->free = cellptr;
417 pool->room = (pool->size + 1) / 2;
419 /* init statistics */
421 pool->total_elements = pool->size;
422 spin_unlock_irqrestore(&pool->lock, flags);
426 /* refuse the further insertion to the pool */
427 void snd_seq_pool_mark_closing(struct snd_seq_pool *pool)
431 if (snd_BUG_ON(!pool))
433 spin_lock_irqsave(&pool->lock, flags);
435 spin_unlock_irqrestore(&pool->lock, flags);
439 int snd_seq_pool_done(struct snd_seq_pool *pool)
442 struct snd_seq_event_cell *ptr;
444 if (snd_BUG_ON(!pool))
447 /* wait for closing all threads */
448 if (waitqueue_active(&pool->output_sleep))
449 wake_up(&pool->output_sleep);
451 while (atomic_read(&pool->counter) > 0)
452 schedule_timeout_uninterruptible(1);
454 /* release all resources */
455 spin_lock_irqsave(&pool->lock, flags);
459 pool->total_elements = 0;
460 spin_unlock_irqrestore(&pool->lock, flags);
464 spin_lock_irqsave(&pool->lock, flags);
466 spin_unlock_irqrestore(&pool->lock, flags);
472 /* init new memory pool */
473 struct snd_seq_pool *snd_seq_pool_new(int poolsize)
475 struct snd_seq_pool *pool;
477 /* create pool block */
478 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
481 spin_lock_init(&pool->lock);
484 pool->total_elements = 0;
485 atomic_set(&pool->counter, 0);
487 init_waitqueue_head(&pool->output_sleep);
489 pool->size = poolsize;
491 /* init statistics */
496 /* remove memory pool */
497 int snd_seq_pool_delete(struct snd_seq_pool **ppool)
499 struct snd_seq_pool *pool = *ppool;
504 snd_seq_pool_mark_closing(pool);
505 snd_seq_pool_done(pool);
510 /* initialize sequencer memory */
511 int __init snd_sequencer_memory_init(void)
516 /* release sequencer memory */
517 void __exit snd_sequencer_memory_done(void)
522 /* exported to seq_clientmgr.c */
523 void snd_seq_info_pool(struct snd_info_buffer *buffer,
524 struct snd_seq_pool *pool, char *space)
528 snd_iprintf(buffer, "%sPool size : %d\n", space, pool->total_elements);
529 snd_iprintf(buffer, "%sCells in use : %d\n", space, atomic_read(&pool->counter));
530 snd_iprintf(buffer, "%sPeak cells in use : %d\n", space, pool->max_used);
531 snd_iprintf(buffer, "%sAlloc success : %d\n", space, pool->event_alloc_success);
532 snd_iprintf(buffer, "%sAlloc failures : %d\n", space, pool->event_alloc_failures);