sound/core/memalloc.c

   1 /*
   2  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
   3  *                   Takashi Iwai <tiwai@suse.de>
   4  *
   5  *  Generic memory allocators
   6  *
   7  *
   8  *   This program is free software; you can redistribute it and/or modify
   9  *   it under the terms of the GNU General Public License as published by
  10  *   the Free Software Foundation; either version 2 of the License, or
  11  *   (at your option) any later version.
  12  *
  13  *   This program is distributed in the hope that it will be useful,
  14  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *   GNU General Public License for more details.
  17  *
  18  *   You should have received a copy of the GNU General Public License
  19  *   along with this program; if not, write to the Free Software
  20  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  21  *
  22  */
  23
  24 #include <linux/module.h>
  25 #include <linux/proc_fs.h>
  26 #include <linux/init.h>
  27 #include <linux/pci.h>
  28 #include <linux/slab.h>
  29 #include <linux/mm.h>
  30 #include <linux/seq_file.h>
  31 #include <asm/uaccess.h>
  32 #include <linux/dma-mapping.h>
  33 #include <linux/moduleparam.h>
  34 #include <linux/mutex.h>
  35 #include <sound/memalloc.h>
  36 #ifdef CONFIG_SBUS
  37 #include <asm/sbus.h>
  38 #endif
  39
  40
  41 MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>, Jaroslav Kysela <perex@perex.cz>");
  42 MODULE_DESCRIPTION("Memory allocator for ALSA system.");
  43 MODULE_LICENSE("GPL");
  44
  45
  46 /*
  47  */
  48
  49 void *snd_malloc_sgbuf_pages(struct device *device,
  50                              size_t size, struct snd_dma_buffer *dmab,
  51                              size_t *res_size);
  52 int snd_free_sgbuf_pages(struct snd_dma_buffer *dmab);
  53
  54 /*
  55  */
  56
  57 static DEFINE_MUTEX(list_mutex);
  58 static LIST_HEAD(mem_list_head);
  59
  60 /* buffer preservation list */
  61 struct snd_mem_list {
  62         struct snd_dma_buffer buffer;
  63         unsigned int id;
  64         struct list_head list;
  65 };
  66
  67 /* id for pre-allocated buffers */
  68 #define SNDRV_DMA_DEVICE_UNUSED (unsigned int)-1
  69
  70 /*
  71  *
  72  *  Generic memory allocators
  73  *
  74  */
  75
  76 static long snd_allocated_pages; /* holding the number of allocated pages */
  77
  78 static inline void inc_snd_pages(int order)
  79 {
  80         snd_allocated_pages += 1 << order;
  81 }
  82
  83 static inline void dec_snd_pages(int order)
  84 {
  85         snd_allocated_pages -= 1 << order;
  86 }
  87
  88 /**
  89  * snd_malloc_pages - allocate pages with the given size
  90  * @size: the size to allocate in bytes
  91  * @gfp_flags: the allocation conditions, GFP_XXX
  92  *
  93  * Allocates the physically contiguous pages with the given size.
  94  *
  95  * Returns the pointer of the buffer, or NULL if no enoguh memory.
  96  */
  97 void *snd_malloc_pages(size_t size, gfp_t gfp_flags)
  98 {
  99         int pg;
 100         void *res;
 101
 102         if (WARN_ON(!size))
 103                 return NULL;
 104         if (WARN_ON(!gfp_flags))
 105                 return NULL;
 106         gfp_flags |= __GFP_COMP;        /* compound page lets parts be mapped */
 107         pg = get_order(size);
 108         if ((res = (void *) __get_free_pages(gfp_flags, pg)) != NULL)
 109                 inc_snd_pages(pg);
 110         return res;
 111 }
 112
 113 /**
 114  * snd_free_pages - release the pages
 115  * @ptr: the buffer pointer to release
 116  * @size: the allocated buffer size
 117  *
 118  * Releases the buffer allocated via snd_malloc_pages().
 119  */
 120 void snd_free_pages(void *ptr, size_t size)
 121 {
 122         int pg;
 123
 124         if (ptr == NULL)
 125                 return;
 126         pg = get_order(size);
 127         dec_snd_pages(pg);
 128         free_pages((unsigned long) ptr, pg);
 129 }
 130
 131 /*
 132  *
 133  *  Bus-specific memory allocators
 134  *
 135  */
 136
 137 #ifdef CONFIG_HAS_DMA
 138 /* allocate the coherent DMA pages */
 139 static void *snd_malloc_dev_pages(struct device *dev, size_t size, dma_addr_t *dma)
 140 {
 141         int pg;
 142         void *res;
 143         gfp_t gfp_flags;
 144
 145         if (WARN_ON(!dma))
 146                 return NULL;
 147         pg = get_order(size);
 148         gfp_flags = GFP_KERNEL
 149                 | __GFP_COMP    /* compound page lets parts be mapped */
 150                 | __GFP_NORETRY /* don't trigger OOM-killer */
 151                 | __GFP_NOWARN; /* no stack trace print - this call is non-critical */
 152         res = dma_alloc_coherent(dev, PAGE_SIZE << pg, dma, gfp_flags);
 153         if (res != NULL)
 154                 inc_snd_pages(pg);
 155
 156         return res;
 157 }
 158
 159 /* free the coherent DMA pages */
 160 static void snd_free_dev_pages(struct device *dev, size_t size, void *ptr,
 161                                dma_addr_t dma)
 162 {
 163         int pg;
 164
 165         if (ptr == NULL)
 166                 return;
 167         pg = get_order(size);
 168         dec_snd_pages(pg);
 169         dma_free_coherent(dev, PAGE_SIZE << pg, ptr, dma);
 170 }
 171 #endif /* CONFIG_HAS_DMA */
 172
 173 #ifdef CONFIG_SBUS
 174
 175 static void *snd_malloc_sbus_pages(struct device *dev, size_t size,
 176                                    dma_addr_t *dma_addr)
 177 {
 178         struct sbus_dev *sdev = (struct sbus_dev *)dev;
 179         int pg;
 180         void *res;
 181
 182         if (WARN_ON(!dma_addr))
 183                 return NULL;
 184         pg = get_order(size);
 185         res = sbus_alloc_consistent(sdev, PAGE_SIZE * (1 << pg), dma_addr);
 186         if (res != NULL)
 187                 inc_snd_pages(pg);
 188         return res;
 189 }
 190
 191 static void snd_free_sbus_pages(struct device *dev, size_t size,
 192                                 void *ptr, dma_addr_t dma_addr)
 193 {
 194         struct sbus_dev *sdev = (struct sbus_dev *)dev;
 195         int pg;
 196
 197         if (ptr == NULL)
 198                 return;
 199         pg = get_order(size);
 200         dec_snd_pages(pg);
 201         sbus_free_consistent(sdev, PAGE_SIZE * (1 << pg), ptr, dma_addr);
 202 }
 203
 204 #endif /* CONFIG_SBUS */
 205
 206 /*
 207  *
 208  *  ALSA generic memory management
 209  *
 210  */
 211
 212
 213 /**
 214  * snd_dma_alloc_pages - allocate the buffer area according to the given type
 215  * @type: the DMA buffer type
 216  * @device: the device pointer
 217  * @size: the buffer size to allocate
 218  * @dmab: buffer allocation record to store the allocated data
 219  *
 220  * Calls the memory-allocator function for the corresponding
 221  * buffer type.
 222  *
 223  * Returns zero if the buffer with the given size is allocated successfuly,
 224  * other a negative value at error.
 225  */
 226 int snd_dma_alloc_pages(int type, struct device *device, size_t size,
 227                         struct snd_dma_buffer *dmab)
 228 {
 229         if (WARN_ON(!size))
 230                 return -ENXIO;
 231         if (WARN_ON(!dmab))
 232                 return -ENXIO;
 233
 234         dmab->dev.type = type;
 235         dmab->dev.dev = device;
 236         dmab->bytes = 0;
 237         switch (type) {
 238         case SNDRV_DMA_TYPE_CONTINUOUS:
 239                 dmab->area = snd_malloc_pages(size, (unsigned long)device);
 240                 dmab->addr = 0;
 241                 break;
 242 #ifdef CONFIG_SBUS
 243         case SNDRV_DMA_TYPE_SBUS:
 244                 dmab->area = snd_malloc_sbus_pages(device, size, &dmab->addr);
 245                 break;
 246 #endif
 247 #ifdef CONFIG_HAS_DMA
 248         case SNDRV_DMA_TYPE_DEV:
 249                 dmab->area = snd_malloc_dev_pages(device, size, &dmab->addr);
 250                 break;
 251         case SNDRV_DMA_TYPE_DEV_SG:
 252                 snd_malloc_sgbuf_pages(device, size, dmab, NULL);
 253                 break;
 254 #endif
 255         default:
 256                 printk(KERN_ERR "snd-malloc: invalid device type %d\n", type);
 257                 dmab->area = NULL;
 258                 dmab->addr = 0;
 259                 return -ENXIO;
 260         }
 261         if (! dmab->area)
 262                 return -ENOMEM;
 263         dmab->bytes = size;
 264         return 0;
 265 }
 266
 267 /**
 268  * snd_dma_alloc_pages_fallback - allocate the buffer area according to the given type with fallback
 269  * @type: the DMA buffer type
 270  * @device: the device pointer
 271  * @size: the buffer size to allocate
 272  * @dmab: buffer allocation record to store the allocated data
 273  *
 274  * Calls the memory-allocator function for the corresponding
 275  * buffer type.  When no space is left, this function reduces the size and
 276  * tries to allocate again.  The size actually allocated is stored in
 277  * res_size argument.
 278  *
 279  * Returns zero if the buffer with the given size is allocated successfuly,
 280  * other a negative value at error.
 281  */
 282 int snd_dma_alloc_pages_fallback(int type, struct device *device, size_t size,
 283                                  struct snd_dma_buffer *dmab)
 284 {
 285         int err;
 286
 287         while ((err = snd_dma_alloc_pages(type, device, size, dmab)) < 0) {
 288                 if (err != -ENOMEM)
 289                         return err;
 290                 size >>= 1;
 291                 if (size <= PAGE_SIZE)
 292                         return -ENOMEM;
 293         }
 294         if (! dmab->area)
 295                 return -ENOMEM;
 296         return 0;
 297 }
 298
 299
 300 /**
 301  * snd_dma_free_pages - release the allocated buffer
 302  * @dmab: the buffer allocation record to release
 303  *
 304  * Releases the allocated buffer via snd_dma_alloc_pages().
 305  */
 306 void snd_dma_free_pages(struct snd_dma_buffer *dmab)
 307 {
 308         switch (dmab->dev.type) {
 309         case SNDRV_DMA_TYPE_CONTINUOUS:
 310                 snd_free_pages(dmab->area, dmab->bytes);
 311                 break;
 312 #ifdef CONFIG_SBUS
 313         case SNDRV_DMA_TYPE_SBUS:
 314                 snd_free_sbus_pages(dmab->dev.dev, dmab->bytes, dmab->area, dmab->addr);
 315                 break;
 316 #endif
 317 #ifdef CONFIG_HAS_DMA
 318         case SNDRV_DMA_TYPE_DEV:
 319                 snd_free_dev_pages(dmab->dev.dev, dmab->bytes, dmab->area, dmab->addr);
 320                 break;
 321         case SNDRV_DMA_TYPE_DEV_SG:
 322                 snd_free_sgbuf_pages(dmab);
 323                 break;
 324 #endif
 325         default:
 326                 printk(KERN_ERR "snd-malloc: invalid device type %d\n", dmab->dev.type);
 327         }
 328 }
 329
 330
 331 /**
 332  * snd_dma_get_reserved - get the reserved buffer for the given device
 333  * @dmab: the buffer allocation record to store
 334  * @id: the buffer id
 335  *
 336  * Looks for the reserved-buffer list and re-uses if the same buffer
 337  * is found in the list.  When the buffer is found, it's removed from the free list.
 338  *
 339  * Returns the size of buffer if the buffer is found, or zero if not found.
 340  */
 341 size_t snd_dma_get_reserved_buf(struct snd_dma_buffer *dmab, unsigned int id)
 342 {
 343         struct snd_mem_list *mem;
 344
 345         if (WARN_ON(!dmab))
 346                 return 0;
 347
 348         mutex_lock(&list_mutex);
 349         list_for_each_entry(mem, &mem_list_head, list) {
 350                 if (mem->id == id &&
 351                     (mem->buffer.dev.dev == NULL || dmab->dev.dev == NULL ||
 352                      ! memcmp(&mem->buffer.dev, &dmab->dev, sizeof(dmab->dev)))) {
 353                         struct device *dev = dmab->dev.dev;
 354                         list_del(&mem->list);
 355                         *dmab = mem->buffer;
 356                         if (dmab->dev.dev == NULL)
 357                                 dmab->dev.dev = dev;
 358                         kfree(mem);
 359                         mutex_unlock(&list_mutex);
 360                         return dmab->bytes;
 361                 }
 362         }
 363         mutex_unlock(&list_mutex);
 364         return 0;
 365 }
 366
 367 /**
 368  * snd_dma_reserve_buf - reserve the buffer
 369  * @dmab: the buffer to reserve
 370  * @id: the buffer id
 371  *
 372  * Reserves the given buffer as a reserved buffer.
 373  *
 374  * Returns zero if successful, or a negative code at error.
 375  */
 376 int snd_dma_reserve_buf(struct snd_dma_buffer *dmab, unsigned int id)
 377 {
 378         struct snd_mem_list *mem;
 379
 380         if (WARN_ON(!dmab))
 381                 return -EINVAL;
 382         mem = kmalloc(sizeof(*mem), GFP_KERNEL);
 383         if (! mem)
 384                 return -ENOMEM;
 385         mutex_lock(&list_mutex);
 386         mem->buffer = *dmab;
 387         mem->id = id;
 388         list_add_tail(&mem->list, &mem_list_head);
 389         mutex_unlock(&list_mutex);
 390         return 0;
 391 }
 392
 393 /*
 394  * purge all reserved buffers
 395  */
 396 static void free_all_reserved_pages(void)
 397 {
 398         struct list_head *p;
 399         struct snd_mem_list *mem;
 400
 401         mutex_lock(&list_mutex);
 402         while (! list_empty(&mem_list_head)) {
 403                 p = mem_list_head.next;
 404                 mem = list_entry(p, struct snd_mem_list, list);
 405                 list_del(p);
 406                 snd_dma_free_pages(&mem->buffer);
 407                 kfree(mem);
 408         }
 409         mutex_unlock(&list_mutex);
 410 }
 411
 412
 413 #ifdef CONFIG_PROC_FS
 414 /*
 415  * proc file interface
 416  */
 417 #define SND_MEM_PROC_FILE       "driver/snd-page-alloc"
 418 static struct proc_dir_entry *snd_mem_proc;
 419
 420 static int snd_mem_proc_read(struct seq_file *seq, void *offset)
 421 {
 422         long pages = snd_allocated_pages >> (PAGE_SHIFT-12);
 423         struct snd_mem_list *mem;
 424         int devno;
 425         static char *types[] = { "UNKNOWN", "CONT", "DEV", "DEV-SG", "SBUS" };
 426
 427         mutex_lock(&list_mutex);
 428         seq_printf(seq, "pages  : %li bytes (%li pages per %likB)\n",
 429                    pages * PAGE_SIZE, pages, PAGE_SIZE / 1024);
 430         devno = 0;
 431         list_for_each_entry(mem, &mem_list_head, list) {
 432                 devno++;
 433                 seq_printf(seq, "buffer %d : ID %08x : type %s\n",
 434                            devno, mem->id, types[mem->buffer.dev.type]);
 435                 seq_printf(seq, "  addr = 0x%lx, size = %d bytes\n",
 436                            (unsigned long)mem->buffer.addr,
 437                            (int)mem->buffer.bytes);
 438         }
 439         mutex_unlock(&list_mutex);
 440         return 0;
 441 }
 442
 443 static int snd_mem_proc_open(struct inode *inode, struct file *file)
 444 {
 445         return single_open(file, snd_mem_proc_read, NULL);
 446 }
 447
 448 /* FIXME: for pci only - other bus? */
 449 #ifdef CONFIG_PCI
 450 #define gettoken(bufp) strsep(bufp, " \t\n")
 451
 452 static ssize_t snd_mem_proc_write(struct file *file, const char __user * buffer,
 453                                   size_t count, loff_t * ppos)
 454 {
 455         char buf[128];
 456         char *token, *p;
 457
 458         if (count > sizeof(buf) - 1)
 459                 return -EINVAL;
 460         if (copy_from_user(buf, buffer, count))
 461                 return -EFAULT;
 462         buf[count] = '\0';
 463
 464         p = buf;
 465         token = gettoken(&p);
 466         if (! token || *token == '#')
 467                 return count;
 468         if (strcmp(token, "add") == 0) {
 469                 char *endp;
 470                 int vendor, device, size, buffers;
 471                 long mask;
 472                 int i, alloced;
 473                 struct pci_dev *pci;
 474
 475                 if ((token = gettoken(&p)) == NULL ||
 476                     (vendor = simple_strtol(token, NULL, 0)) <= 0 ||
 477                     (token = gettoken(&p)) == NULL ||
 478                     (device = simple_strtol(token, NULL, 0)) <= 0 ||
 479                     (token = gettoken(&p)) == NULL ||
 480                     (mask = simple_strtol(token, NULL, 0)) < 0 ||
 481                     (token = gettoken(&p)) == NULL ||
 482                     (size = memparse(token, &endp)) < 64*1024 ||
 483                     size > 16*1024*1024 /* too big */ ||
 484                     (token = gettoken(&p)) == NULL ||
 485                     (buffers = simple_strtol(token, NULL, 0)) <= 0 ||
 486                     buffers > 4) {
 487                         printk(KERN_ERR "snd-page-alloc: invalid proc write format\n");
 488                         return count;
 489                 }
 490                 vendor &= 0xffff;
 491                 device &= 0xffff;
 492
 493                 alloced = 0;
 494                 pci = NULL;
 495                 while ((pci = pci_get_device(vendor, device, pci)) != NULL) {
 496                         if (mask > 0 && mask < 0xffffffff) {
 497                                 if (pci_set_dma_mask(pci, mask) < 0 ||
 498                                     pci_set_consistent_dma_mask(pci, mask) < 0) {
 499                                         printk(KERN_ERR "snd-page-alloc: cannot set DMA mask %lx for pci %04x:%04x\n", mask, vendor, device);
 500                                         pci_dev_put(pci);
 501                                         return count;
 502                                 }
 503                         }
 504                         for (i = 0; i < buffers; i++) {
 505                                 struct snd_dma_buffer dmab;
 506                                 memset(&dmab, 0, sizeof(dmab));
 507                                 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, snd_dma_pci_data(pci),
 508                                                         size, &dmab) < 0) {
 509                                         printk(KERN_ERR "snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size);
 510                                         pci_dev_put(pci);
 511                                         return count;
 512                                 }
 513                                 snd_dma_reserve_buf(&dmab, snd_dma_pci_buf_id(pci));
 514                         }
 515                         alloced++;
 516                 }
 517                 if (! alloced) {
 518                         for (i = 0; i < buffers; i++) {
 519                                 struct snd_dma_buffer dmab;
 520                                 memset(&dmab, 0, sizeof(dmab));
 521                                 /* FIXME: We can allocate only in ZONE_DMA
 522                                  * without a device pointer!
 523                                  */
 524                                 if (snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, NULL,
 525                                                         size, &dmab) < 0) {
 526                                         printk(KERN_ERR "snd-page-alloc: cannot allocate buffer pages (size = %d)\n", size);
 527                                         break;
 528                                 }
 529                                 snd_dma_reserve_buf(&dmab, (unsigned int)((vendor << 16) | device));
 530                         }
 531                 }
 532         } else if (strcmp(token, "erase") == 0)
 533                 /* FIXME: need for releasing each buffer chunk? */
 534                 free_all_reserved_pages();
 535         else
 536                 printk(KERN_ERR "snd-page-alloc: invalid proc cmd\n");
 537         return count;
 538 }
 539 #endif /* CONFIG_PCI */
 540
 541 static const struct file_operations snd_mem_proc_fops = {
 542         .owner          = THIS_MODULE,
 543         .open           = snd_mem_proc_open,
 544         .read           = seq_read,
 545 #ifdef CONFIG_PCI
 546         .write          = snd_mem_proc_write,
 547 #endif
 548         .llseek         = seq_lseek,
 549         .release        = single_release,
 550 };
 551
 552 #endif /* CONFIG_PROC_FS */
 553
 554 /*
 555  * module entry
 556  */
 557
 558 static int __init snd_mem_init(void)
 559 {
 560 #ifdef CONFIG_PROC_FS
 561         snd_mem_proc = proc_create(SND_MEM_PROC_FILE, 0644, NULL,
 562                                    &snd_mem_proc_fops);
 563 #endif
 564         return 0;
 565 }
 566
 567 static void __exit snd_mem_exit(void)
 568 {
 569         remove_proc_entry(SND_MEM_PROC_FILE, NULL);
 570         free_all_reserved_pages();
 571         if (snd_allocated_pages > 0)
 572                 printk(KERN_ERR "snd-malloc: Memory leak?  pages not freed = %li\n", snd_allocated_pages);
 573 }
 574
 575
 576 module_init(snd_mem_init)
 577 module_exit(snd_mem_exit)
 578
 579
 580 /*
 581  * exports
 582  */
 583 EXPORT_SYMBOL(snd_dma_alloc_pages);
 584 EXPORT_SYMBOL(snd_dma_alloc_pages_fallback);
 585 EXPORT_SYMBOL(snd_dma_free_pages);
 586
 587 EXPORT_SYMBOL(snd_dma_get_reserved_buf);
 588 EXPORT_SYMBOL(snd_dma_reserve_buf);
 589
 590 EXPORT_SYMBOL(snd_malloc_pages);
 591 EXPORT_SYMBOL(snd_free_pages);