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/sched/signal.h>
27 #include <linux/vmalloc.h>
28 #include <sound/core.h>
30 #include <sound/seq_kernel.h>
31 #include "seq_memory.h"
32 #include "seq_queue.h"
36 static inline int snd_seq_pool_available(struct snd_seq_pool *pool)
38 return pool->total_elements - atomic_read(&pool->counter);
41 static inline int snd_seq_output_ok(struct snd_seq_pool *pool)
43 return snd_seq_pool_available(pool) >= pool->room;
47 * Variable length event:
48 * The event like sysex uses variable length type.
49 * The external data may be stored in three different formats.
51 * This is the normal case.
52 * ext.data.len = length
53 * ext.data.ptr = buffer pointer
55 * When an event is generated via read(), the external data is
56 * kept in user space until expanded.
57 * ext.data.len = length | SNDRV_SEQ_EXT_USRPTR
58 * ext.data.ptr = userspace pointer
60 * When the variable length event is enqueued (in prioq or fifo),
61 * the external data is decomposed to several cells.
62 * ext.data.len = length | SNDRV_SEQ_EXT_CHAINED
63 * ext.data.ptr = the additiona cell head
64 * -> cell.next -> cell.next -> ..
69 * call dump function to expand external data.
72 static int get_var_len(const struct snd_seq_event *event)
74 if ((event->flags & SNDRV_SEQ_EVENT_LENGTH_MASK) != SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
77 return event->data.ext.len & ~SNDRV_SEQ_EXT_MASK;
80 int snd_seq_dump_var_event(const struct snd_seq_event *event,
81 snd_seq_dump_func_t func, void *private_data)
84 struct snd_seq_event_cell *cell;
86 if ((len = get_var_len(event)) <= 0)
89 if (event->data.ext.len & SNDRV_SEQ_EXT_USRPTR) {
91 char __user *curptr = (char __force __user *)event->data.ext.ptr;
93 int size = sizeof(buf);
96 if (copy_from_user(buf, curptr, size))
98 err = func(private_data, buf, size);
106 if (!(event->data.ext.len & SNDRV_SEQ_EXT_CHAINED))
107 return func(private_data, event->data.ext.ptr, len);
109 cell = (struct snd_seq_event_cell *)event->data.ext.ptr;
110 for (; len > 0 && cell; cell = cell->next) {
111 int size = sizeof(struct snd_seq_event);
114 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;
174 EXPORT_SYMBOL(snd_seq_expand_var_event);
177 * release this cell, free extended data if available
180 static inline void free_cell(struct snd_seq_pool *pool,
181 struct snd_seq_event_cell *cell)
183 cell->next = pool->free;
185 atomic_dec(&pool->counter);
188 void snd_seq_cell_free(struct snd_seq_event_cell * cell)
191 struct snd_seq_pool *pool;
193 if (snd_BUG_ON(!cell))
196 if (snd_BUG_ON(!pool))
199 spin_lock_irqsave(&pool->lock, flags);
200 free_cell(pool, cell);
201 if (snd_seq_ev_is_variable(&cell->event)) {
202 if (cell->event.data.ext.len & SNDRV_SEQ_EXT_CHAINED) {
203 struct snd_seq_event_cell *curp, *nextptr;
204 curp = cell->event.data.ext.ptr;
205 for (; curp; curp = nextptr) {
206 nextptr = curp->next;
207 curp->next = pool->free;
208 free_cell(pool, curp);
212 if (waitqueue_active(&pool->output_sleep)) {
213 /* has enough space now? */
214 if (snd_seq_output_ok(pool))
215 wake_up(&pool->output_sleep);
217 spin_unlock_irqrestore(&pool->lock, flags);
222 * allocate an event cell.
224 static int snd_seq_cell_alloc(struct snd_seq_pool *pool,
225 struct snd_seq_event_cell **cellp,
226 int nonblock, struct file *file,
227 struct mutex *mutexp)
229 struct snd_seq_event_cell *cell;
232 wait_queue_entry_t wait;
239 init_waitqueue_entry(&wait, current);
240 spin_lock_irqsave(&pool->lock, flags);
241 if (pool->ptr == NULL) { /* not initialized */
242 pr_debug("ALSA: seq: pool is not initialized\n");
246 while (pool->free == NULL && ! nonblock && ! pool->closing) {
248 set_current_state(TASK_INTERRUPTIBLE);
249 add_wait_queue(&pool->output_sleep, &wait);
250 spin_unlock_irq(&pool->lock);
252 mutex_unlock(mutexp);
256 spin_lock_irq(&pool->lock);
257 remove_wait_queue(&pool->output_sleep, &wait);
259 if (signal_pending(current)) {
264 if (pool->closing) { /* closing.. */
272 pool->free = cell->next;
273 atomic_inc(&pool->counter);
274 used = atomic_read(&pool->counter);
275 if (pool->max_used < used)
276 pool->max_used = used;
277 pool->event_alloc_success++;
278 /* clear cell pointers */
282 pool->event_alloc_failures++;
286 spin_unlock_irqrestore(&pool->lock, flags);
292 * duplicate the event to a cell.
293 * if the event has external data, the data is decomposed to additional
296 int snd_seq_event_dup(struct snd_seq_pool *pool, struct snd_seq_event *event,
297 struct snd_seq_event_cell **cellp, int nonblock,
298 struct file *file, struct mutex *mutexp)
302 struct snd_seq_event_cell *cell;
308 if (snd_seq_ev_is_variable(event)) {
309 extlen = event->data.ext.len & ~SNDRV_SEQ_EXT_MASK;
310 ncells = (extlen + sizeof(struct snd_seq_event) - 1) / sizeof(struct snd_seq_event);
312 if (ncells >= pool->total_elements)
315 err = snd_seq_cell_alloc(pool, &cell, nonblock, file, mutexp);
320 cell->event = *event;
323 if (snd_seq_ev_is_variable(event)) {
325 int is_chained = event->data.ext.len & SNDRV_SEQ_EXT_CHAINED;
326 int is_usrptr = event->data.ext.len & SNDRV_SEQ_EXT_USRPTR;
327 struct snd_seq_event_cell *src, *tmp, *tail;
330 cell->event.data.ext.len = extlen | SNDRV_SEQ_EXT_CHAINED;
331 cell->event.data.ext.ptr = NULL;
333 src = (struct snd_seq_event_cell *)event->data.ext.ptr;
334 buf = (char *)event->data.ext.ptr;
337 while (ncells-- > 0) {
338 int size = sizeof(struct snd_seq_event);
341 err = snd_seq_cell_alloc(pool, &tmp, nonblock, file,
345 if (cell->event.data.ext.ptr == NULL)
346 cell->event.data.ext.ptr = tmp;
351 if (is_chained && src) {
352 tmp->event = src->event;
354 } else if (is_usrptr) {
355 if (copy_from_user(&tmp->event, (char __force __user *)buf, size)) {
360 memcpy(&tmp->event, buf, size);
371 snd_seq_cell_free(cell);
377 int snd_seq_pool_poll_wait(struct snd_seq_pool *pool, struct file *file,
380 poll_wait(file, &pool->output_sleep, wait);
381 return snd_seq_output_ok(pool);
385 /* allocate room specified number of events */
386 int snd_seq_pool_init(struct snd_seq_pool *pool)
389 struct snd_seq_event_cell *cellptr;
392 if (snd_BUG_ON(!pool))
395 cellptr = vmalloc(sizeof(struct snd_seq_event_cell) * pool->size);
399 /* add new cells to the free cell list */
400 spin_lock_irqsave(&pool->lock, flags);
402 spin_unlock_irqrestore(&pool->lock, flags);
410 for (cell = 0; cell < pool->size; cell++) {
411 cellptr = pool->ptr + cell;
412 cellptr->pool = pool;
413 cellptr->next = pool->free;
414 pool->free = cellptr;
416 pool->room = (pool->size + 1) / 2;
418 /* init statistics */
420 pool->total_elements = pool->size;
421 spin_unlock_irqrestore(&pool->lock, flags);
425 /* refuse the further insertion to the pool */
426 void snd_seq_pool_mark_closing(struct snd_seq_pool *pool)
430 if (snd_BUG_ON(!pool))
432 spin_lock_irqsave(&pool->lock, flags);
434 spin_unlock_irqrestore(&pool->lock, flags);
438 int snd_seq_pool_done(struct snd_seq_pool *pool)
441 struct snd_seq_event_cell *ptr;
443 if (snd_BUG_ON(!pool))
446 /* wait for closing all threads */
447 if (waitqueue_active(&pool->output_sleep))
448 wake_up(&pool->output_sleep);
450 while (atomic_read(&pool->counter) > 0)
451 schedule_timeout_uninterruptible(1);
453 /* release all resources */
454 spin_lock_irqsave(&pool->lock, flags);
458 pool->total_elements = 0;
459 spin_unlock_irqrestore(&pool->lock, flags);
463 spin_lock_irqsave(&pool->lock, flags);
465 spin_unlock_irqrestore(&pool->lock, flags);
471 /* init new memory pool */
472 struct snd_seq_pool *snd_seq_pool_new(int poolsize)
474 struct snd_seq_pool *pool;
476 /* create pool block */
477 pool = kzalloc(sizeof(*pool), GFP_KERNEL);
480 spin_lock_init(&pool->lock);
483 pool->total_elements = 0;
484 atomic_set(&pool->counter, 0);
486 init_waitqueue_head(&pool->output_sleep);
488 pool->size = poolsize;
490 /* init statistics */
495 /* remove memory pool */
496 int snd_seq_pool_delete(struct snd_seq_pool **ppool)
498 struct snd_seq_pool *pool = *ppool;
503 snd_seq_pool_mark_closing(pool);
504 snd_seq_pool_done(pool);
509 /* initialize sequencer memory */
510 int __init snd_sequencer_memory_init(void)
515 /* release sequencer memory */
516 void __exit snd_sequencer_memory_done(void)
521 /* exported to seq_clientmgr.c */
522 void snd_seq_info_pool(struct snd_info_buffer *buffer,
523 struct snd_seq_pool *pool, char *space)
527 snd_iprintf(buffer, "%sPool size : %d\n", space, pool->total_elements);
528 snd_iprintf(buffer, "%sCells in use : %d\n", space, atomic_read(&pool->counter));
529 snd_iprintf(buffer, "%sPeak cells in use : %d\n", space, pool->max_used);
530 snd_iprintf(buffer, "%sAlloc success : %d\n", space, pool->event_alloc_success);
531 snd_iprintf(buffer, "%sAlloc failures : %d\n", space, pool->event_alloc_failures);