sound/core/seq/seq_memory.c

   1 /*
   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>
   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 <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>
  29
  30 #include <sound/seq_kernel.h>
  31 #include "seq_memory.h"
  32 #include "seq_queue.h"
  33 #include "seq_info.h"
  34 #include "seq_lock.h"
  35
  36 static inline int snd_seq_pool_available(struct snd_seq_pool *pool)
  37 {
  38         return pool->total_elements - atomic_read(&pool->counter);
  39 }
  40
  41 static inline int snd_seq_output_ok(struct snd_seq_pool *pool)
  42 {
  43         return snd_seq_pool_available(pool) >= pool->room;
  44 }
  45
  46 /*
  47  * Variable length event:
  48  * The event like sysex uses variable length type.
  49  * The external data may be stored in three different formats.
  50  * 1) kernel space
  51  *    This is the normal case.
  52  *      ext.data.len = length
  53  *      ext.data.ptr = buffer pointer
  54  * 2) user space
  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
  59  * 3) chained cells
  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 -> ..
  65  */
  66
  67 /*
  68  * exported:
  69  * call dump function to expand external data.
  70  */
  71
  72 static int get_var_len(const struct snd_seq_event *event)
  73 {
  74         if ((event->flags & SNDRV_SEQ_EVENT_LENGTH_MASK) != SNDRV_SEQ_EVENT_LENGTH_VARIABLE)
  75                 return -EINVAL;
  76
  77         return event->data.ext.len & ~SNDRV_SEQ_EXT_MASK;
  78 }
  79
  80 int snd_seq_dump_var_event(const struct snd_seq_event *event,
  81                            snd_seq_dump_func_t func, void *private_data)
  82 {
  83         int len, err;
  84         struct snd_seq_event_cell *cell;
  85
  86         if ((len = get_var_len(event)) <= 0)
  87                 return len;
  88
  89         if (event->data.ext.len & SNDRV_SEQ_EXT_USRPTR) {
  90                 char buf[32];
  91                 char __user *curptr = (char __force __user *)event->data.ext.ptr;
  92                 while (len > 0) {
  93                         int size = sizeof(buf);
  94                         if (len < size)
  95                                 size = len;
  96                         if (copy_from_user(buf, curptr, size))
  97                                 return -EFAULT;
  98                         err = func(private_data, buf, size);
  99                         if (err < 0)
 100                                 return err;
 101                         curptr += size;
 102                         len -= size;
 103                 }
 104                 return 0;
 105         }
 106         if (!(event->data.ext.len & SNDRV_SEQ_EXT_CHAINED))
 107                 return func(private_data, event->data.ext.ptr, len);
 108
 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);
 112                 if (len < size)
 113                         size = len;
 114                 err = func(private_data, &cell->event, size);
 115                 if (err < 0)
 116                         return err;
 117                 len -= size;
 118         }
 119         return 0;
 120 }
 121 EXPORT_SYMBOL(snd_seq_dump_var_event);
 122
 123
 124 /*
 125  * exported:
 126  * expand the variable length event to linear buffer space.
 127  */
 128
 129 static int seq_copy_in_kernel(void *ptr, void *src, int size)
 130 {
 131         char **bufptr = ptr;
 132
 133         memcpy(*bufptr, src, size);
 134         *bufptr += size;
 135         return 0;
 136 }
 137
 138 static int seq_copy_in_user(void *ptr, void *src, int size)
 139 {
 140         char __user **bufptr = ptr;
 141
 142         if (copy_to_user(*bufptr, src, size))
 143                 return -EFAULT;
 144         *bufptr += size;
 145         return 0;
 146 }
 147
 148 int snd_seq_expand_var_event(const struct snd_seq_event *event, int count, char *buf,
 149                              int in_kernel, int size_aligned)
 150 {
 151         int len, newlen;
 152         int err;
 153
 154         if ((len = get_var_len(event)) < 0)
 155                 return len;
 156         newlen = len;
 157         if (size_aligned > 0)
 158                 newlen = roundup(len, size_aligned);
 159         if (count < newlen)
 160                 return -EAGAIN;
 161
 162         if (event->data.ext.len & SNDRV_SEQ_EXT_USRPTR) {
 163                 if (! in_kernel)
 164                         return -EINVAL;
 165                 if (copy_from_user(buf, (void __force __user *)event->data.ext.ptr, len))
 166                         return -EFAULT;
 167                 return newlen;
 168         }
 169         err = snd_seq_dump_var_event(event,
 170                                      in_kernel ? seq_copy_in_kernel : seq_copy_in_user,
 171                                      &buf);
 172         return err < 0 ? err : newlen;
 173 }
 174 EXPORT_SYMBOL(snd_seq_expand_var_event);
 175
 176 /*
 177  * release this cell, free extended data if available
 178  */
 179
 180 static inline void free_cell(struct snd_seq_pool *pool,
 181                              struct snd_seq_event_cell *cell)
 182 {
 183         cell->next = pool->free;
 184         pool->free = cell;
 185         atomic_dec(&pool->counter);
 186 }
 187
 188 void snd_seq_cell_free(struct snd_seq_event_cell * cell)
 189 {
 190         unsigned long flags;
 191         struct snd_seq_pool *pool;
 192
 193         if (snd_BUG_ON(!cell))
 194                 return;
 195         pool = cell->pool;
 196         if (snd_BUG_ON(!pool))
 197                 return;
 198
 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);
 209                         }
 210                 }
 211         }
 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);
 216         }
 217         spin_unlock_irqrestore(&pool->lock, flags);
 218 }
 219
 220
 221 /*
 222  * allocate an event cell.
 223  */
 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)
 228 {
 229         struct snd_seq_event_cell *cell;
 230         unsigned long flags;
 231         int err = -EAGAIN;
 232         wait_queue_entry_t wait;
 233
 234         if (pool == NULL)
 235                 return -EINVAL;
 236
 237         *cellp = NULL;
 238
 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");
 243                 err = -EINVAL;
 244                 goto __error;
 245         }
 246         while (pool->free == NULL && ! nonblock && ! pool->closing) {
 247
 248                 set_current_state(TASK_INTERRUPTIBLE);
 249                 add_wait_queue(&pool->output_sleep, &wait);
 250                 spin_unlock_irq(&pool->lock);
 251                 if (mutexp)
 252                         mutex_unlock(mutexp);
 253                 schedule();
 254                 if (mutexp)
 255                         mutex_lock(mutexp);
 256                 spin_lock_irq(&pool->lock);
 257                 remove_wait_queue(&pool->output_sleep, &wait);
 258                 /* interrupted? */
 259                 if (signal_pending(current)) {
 260                         err = -ERESTARTSYS;
 261                         goto __error;
 262                 }
 263         }
 264         if (pool->closing) { /* closing.. */
 265                 err = -ENOMEM;
 266                 goto __error;
 267         }
 268
 269         cell = pool->free;
 270         if (cell) {
 271                 int used;
 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 */
 279                 cell->next = NULL;
 280                 err = 0;
 281         } else
 282                 pool->event_alloc_failures++;
 283         *cellp = cell;
 284
 285 __error:
 286         spin_unlock_irqrestore(&pool->lock, flags);
 287         return err;
 288 }
 289
 290
 291 /*
 292  * duplicate the event to a cell.
 293  * if the event has external data, the data is decomposed to additional
 294  * cells.
 295  */
 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)
 299 {
 300         int ncells, err;
 301         unsigned int extlen;
 302         struct snd_seq_event_cell *cell;
 303
 304         *cellp = NULL;
 305
 306         ncells = 0;
 307         extlen = 0;
 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);
 311         }
 312         if (ncells >= pool->total_elements)
 313                 return -ENOMEM;
 314
 315         err = snd_seq_cell_alloc(pool, &cell, nonblock, file, mutexp);
 316         if (err < 0)
 317                 return err;
 318
 319         /* copy the event */
 320         cell->event = *event;
 321
 322         /* decompose */
 323         if (snd_seq_ev_is_variable(event)) {
 324                 int len = extlen;
 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;
 328                 char *buf;
 329
 330                 cell->event.data.ext.len = extlen | SNDRV_SEQ_EXT_CHAINED;
 331                 cell->event.data.ext.ptr = NULL;
 332
 333                 src = (struct snd_seq_event_cell *)event->data.ext.ptr;
 334                 buf = (char *)event->data.ext.ptr;
 335                 tail = NULL;
 336
 337                 while (ncells-- > 0) {
 338                         int size = sizeof(struct snd_seq_event);
 339                         if (len < size)
 340                                 size = len;
 341                         err = snd_seq_cell_alloc(pool, &tmp, nonblock, file,
 342                                                  mutexp);
 343                         if (err < 0)
 344                                 goto __error;
 345                         if (cell->event.data.ext.ptr == NULL)
 346                                 cell->event.data.ext.ptr = tmp;
 347                         if (tail)
 348                                 tail->next = tmp;
 349                         tail = tmp;
 350                         /* copy chunk */
 351                         if (is_chained && src) {
 352                                 tmp->event = src->event;
 353                                 src = src->next;
 354                         } else if (is_usrptr) {
 355                                 if (copy_from_user(&tmp->event, (char __force __user *)buf, size)) {
 356                                         err = -EFAULT;
 357                                         goto __error;
 358                                 }
 359                         } else {
 360                                 memcpy(&tmp->event, buf, size);
 361                         }
 362                         buf += size;
 363                         len -= size;
 364                 }
 365         }
 366
 367         *cellp = cell;
 368         return 0;
 369
 370 __error:
 371         snd_seq_cell_free(cell);
 372         return err;
 373 }
 374
 375
 376 /* poll wait */
 377 int snd_seq_pool_poll_wait(struct snd_seq_pool *pool, struct file *file,
 378                            poll_table *wait)
 379 {
 380         poll_wait(file, &pool->output_sleep, wait);
 381         return snd_seq_output_ok(pool);
 382 }
 383
 384
 385 /* allocate room specified number of events */
 386 int snd_seq_pool_init(struct snd_seq_pool *pool)
 387 {
 388         int cell;
 389         struct snd_seq_event_cell *cellptr;
 390         unsigned long flags;
 391
 392         if (snd_BUG_ON(!pool))
 393                 return -EINVAL;
 394
 395         cellptr = vmalloc(array_size(sizeof(struct snd_seq_event_cell),
 396                                      pool->size));
 397         if (!cellptr)
 398                 return -ENOMEM;
 399
 400         /* add new cells to the free cell list */
 401         spin_lock_irqsave(&pool->lock, flags);
 402         if (pool->ptr) {
 403                 spin_unlock_irqrestore(&pool->lock, flags);
 404                 vfree(cellptr);
 405                 return 0;
 406         }
 407
 408         pool->ptr = cellptr;
 409         pool->free = NULL;
 410
 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;
 416         }
 417         pool->room = (pool->size + 1) / 2;
 418
 419         /* init statistics */
 420         pool->max_used = 0;
 421         pool->total_elements = pool->size;
 422         spin_unlock_irqrestore(&pool->lock, flags);
 423         return 0;
 424 }
 425
 426 /* refuse the further insertion to the pool */
 427 void snd_seq_pool_mark_closing(struct snd_seq_pool *pool)
 428 {
 429         unsigned long flags;
 430
 431         if (snd_BUG_ON(!pool))
 432                 return;
 433         spin_lock_irqsave(&pool->lock, flags);
 434         pool->closing = 1;
 435         spin_unlock_irqrestore(&pool->lock, flags);
 436 }
 437
 438 /* remove events */
 439 int snd_seq_pool_done(struct snd_seq_pool *pool)
 440 {
 441         unsigned long flags;
 442         struct snd_seq_event_cell *ptr;
 443
 444         if (snd_BUG_ON(!pool))
 445                 return -EINVAL;
 446
 447         /* wait for closing all threads */
 448         if (waitqueue_active(&pool->output_sleep))
 449                 wake_up(&pool->output_sleep);
 450
 451         while (atomic_read(&pool->counter) > 0)
 452                 schedule_timeout_uninterruptible(1);
 453
 454         /* release all resources */
 455         spin_lock_irqsave(&pool->lock, flags);
 456         ptr = pool->ptr;
 457         pool->ptr = NULL;
 458         pool->free = NULL;
 459         pool->total_elements = 0;
 460         spin_unlock_irqrestore(&pool->lock, flags);
 461
 462         vfree(ptr);
 463
 464         spin_lock_irqsave(&pool->lock, flags);
 465         pool->closing = 0;
 466         spin_unlock_irqrestore(&pool->lock, flags);
 467
 468         return 0;
 469 }
 470
 471
 472 /* init new memory pool */
 473 struct snd_seq_pool *snd_seq_pool_new(int poolsize)
 474 {
 475         struct snd_seq_pool *pool;
 476
 477         /* create pool block */
 478         pool = kzalloc(sizeof(*pool), GFP_KERNEL);
 479         if (!pool)
 480                 return NULL;
 481         spin_lock_init(&pool->lock);
 482         pool->ptr = NULL;
 483         pool->free = NULL;
 484         pool->total_elements = 0;
 485         atomic_set(&pool->counter, 0);
 486         pool->closing = 0;
 487         init_waitqueue_head(&pool->output_sleep);
 488
 489         pool->size = poolsize;
 490
 491         /* init statistics */
 492         pool->max_used = 0;
 493         return pool;
 494 }
 495
 496 /* remove memory pool */
 497 int snd_seq_pool_delete(struct snd_seq_pool **ppool)
 498 {
 499         struct snd_seq_pool *pool = *ppool;
 500
 501         *ppool = NULL;
 502         if (pool == NULL)
 503                 return 0;
 504         snd_seq_pool_mark_closing(pool);
 505         snd_seq_pool_done(pool);
 506         kfree(pool);
 507         return 0;
 508 }
 509
 510 /* exported to seq_clientmgr.c */
 511 void snd_seq_info_pool(struct snd_info_buffer *buffer,
 512                        struct snd_seq_pool *pool, char *space)
 513 {
 514         if (pool == NULL)
 515                 return;
 516         snd_iprintf(buffer, "%sPool size          : %d\n", space, pool->total_elements);
 517         snd_iprintf(buffer, "%sCells in use       : %d\n", space, atomic_read(&pool->counter));
 518         snd_iprintf(buffer, "%sPeak cells in use  : %d\n", space, pool->max_used);
 519         snd_iprintf(buffer, "%sAlloc success      : %d\n", space, pool->event_alloc_success);
 520         snd_iprintf(buffer, "%sAlloc failures     : %d\n", space, pool->event_alloc_failures);
 521 }