sound/core/pcm_memory.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  Digital Audio (PCM) abstract layer
   4  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
   5  */
   6
   7 #include <linux/io.h>
   8 #include <linux/time.h>
   9 #include <linux/init.h>
  10 #include <linux/slab.h>
  11 #include <linux/moduleparam.h>
  12 #include <linux/vmalloc.h>
  13 #include <linux/export.h>
  14 #include <sound/core.h>
  15 #include <sound/pcm.h>
  16 #include <sound/info.h>
  17 #include <sound/initval.h>
  18 #include "pcm_local.h"
  19
  20 static int preallocate_dma = 1;
  21 module_param(preallocate_dma, int, 0444);
  22 MODULE_PARM_DESC(preallocate_dma, "Preallocate DMA memory when the PCM devices are initialized.");
  23
  24 static int maximum_substreams = 4;
  25 module_param(maximum_substreams, int, 0444);
  26 MODULE_PARM_DESC(maximum_substreams, "Maximum substreams with preallocated DMA memory.");
  27
  28 static const size_t snd_minimum_buffer = 16384;
  29
  30 static unsigned long max_alloc_per_card = 32UL * 1024UL * 1024UL;
  31 module_param(max_alloc_per_card, ulong, 0644);
  32 MODULE_PARM_DESC(max_alloc_per_card, "Max total allocation bytes per card.");
  33
  34 static int do_alloc_pages(struct snd_card *card, int type, struct device *dev,
  35                           int str, size_t size, struct snd_dma_buffer *dmab)
  36 {
  37         enum dma_data_direction dir;
  38         int err;
  39
  40         if (max_alloc_per_card &&
  41             card->total_pcm_alloc_bytes + size > max_alloc_per_card)
  42                 return -ENOMEM;
  43
  44         if (str == SNDRV_PCM_STREAM_PLAYBACK)
  45                 dir = DMA_TO_DEVICE;
  46         else
  47                 dir = DMA_FROM_DEVICE;
  48         err = snd_dma_alloc_dir_pages(type, dev, dir, size, dmab);
  49         if (!err) {
  50                 mutex_lock(&card->memory_mutex);
  51                 card->total_pcm_alloc_bytes += dmab->bytes;
  52                 mutex_unlock(&card->memory_mutex);
  53         }
  54         return err;
  55 }
  56
  57 static void do_free_pages(struct snd_card *card, struct snd_dma_buffer *dmab)
  58 {
  59         if (!dmab->area)
  60                 return;
  61         mutex_lock(&card->memory_mutex);
  62         WARN_ON(card->total_pcm_alloc_bytes < dmab->bytes);
  63         card->total_pcm_alloc_bytes -= dmab->bytes;
  64         mutex_unlock(&card->memory_mutex);
  65         snd_dma_free_pages(dmab);
  66         dmab->area = NULL;
  67 }
  68
  69 /*
  70  * try to allocate as the large pages as possible.
  71  * stores the resultant memory size in *res_size.
  72  *
  73  * the minimum size is snd_minimum_buffer.  it should be power of 2.
  74  */
  75 static int preallocate_pcm_pages(struct snd_pcm_substream *substream,
  76                                  size_t size, bool no_fallback)
  77 {
  78         struct snd_dma_buffer *dmab = &substream->dma_buffer;
  79         struct snd_card *card = substream->pcm->card;
  80         size_t orig_size = size;
  81         int err;
  82
  83         do {
  84                 err = do_alloc_pages(card, dmab->dev.type, dmab->dev.dev,
  85                                      substream->stream, size, dmab);
  86                 if (err != -ENOMEM)
  87                         return err;
  88                 if (no_fallback)
  89                         break;
  90                 size >>= 1;
  91         } while (size >= snd_minimum_buffer);
  92         dmab->bytes = 0; /* tell error */
  93         pr_warn("ALSA pcmC%dD%d%c,%d:%s: cannot preallocate for size %zu\n",
  94                 substream->pcm->card->number, substream->pcm->device,
  95                 substream->stream ? 'c' : 'p', substream->number,
  96                 substream->pcm->name, orig_size);
  97         return -ENOMEM;
  98 }
  99
 100 /**
 101  * snd_pcm_lib_preallocate_free - release the preallocated buffer of the specified substream.
 102  * @substream: the pcm substream instance
 103  *
 104  * Releases the pre-allocated buffer of the given substream.
 105  */
 106 void snd_pcm_lib_preallocate_free(struct snd_pcm_substream *substream)
 107 {
 108         do_free_pages(substream->pcm->card, &substream->dma_buffer);
 109 }
 110
 111 /**
 112  * snd_pcm_lib_preallocate_free_for_all - release all pre-allocated buffers on the pcm
 113  * @pcm: the pcm instance
 114  *
 115  * Releases all the pre-allocated buffers on the given pcm.
 116  */
 117 void snd_pcm_lib_preallocate_free_for_all(struct snd_pcm *pcm)
 118 {
 119         struct snd_pcm_substream *substream;
 120         int stream;
 121
 122         for_each_pcm_substream(pcm, stream, substream)
 123                 snd_pcm_lib_preallocate_free(substream);
 124 }
 125 EXPORT_SYMBOL(snd_pcm_lib_preallocate_free_for_all);
 126
 127 #ifdef CONFIG_SND_VERBOSE_PROCFS
 128 /*
 129  * read callback for prealloc proc file
 130  *
 131  * prints the current allocated size in kB.
 132  */
 133 static void snd_pcm_lib_preallocate_proc_read(struct snd_info_entry *entry,
 134                                               struct snd_info_buffer *buffer)
 135 {
 136         struct snd_pcm_substream *substream = entry->private_data;
 137         snd_iprintf(buffer, "%lu\n", (unsigned long) substream->dma_buffer.bytes / 1024);
 138 }
 139
 140 /*
 141  * read callback for prealloc_max proc file
 142  *
 143  * prints the maximum allowed size in kB.
 144  */
 145 static void snd_pcm_lib_preallocate_max_proc_read(struct snd_info_entry *entry,
 146                                                   struct snd_info_buffer *buffer)
 147 {
 148         struct snd_pcm_substream *substream = entry->private_data;
 149         snd_iprintf(buffer, "%lu\n", (unsigned long) substream->dma_max / 1024);
 150 }
 151
 152 /*
 153  * write callback for prealloc proc file
 154  *
 155  * accepts the preallocation size in kB.
 156  */
 157 static void snd_pcm_lib_preallocate_proc_write(struct snd_info_entry *entry,
 158                                                struct snd_info_buffer *buffer)
 159 {
 160         struct snd_pcm_substream *substream = entry->private_data;
 161         struct snd_card *card = substream->pcm->card;
 162         char line[64], str[64];
 163         size_t size;
 164         struct snd_dma_buffer new_dmab;
 165
 166         if (substream->runtime) {
 167                 buffer->error = -EBUSY;
 168                 return;
 169         }
 170         if (!snd_info_get_line(buffer, line, sizeof(line))) {
 171                 snd_info_get_str(str, line, sizeof(str));
 172                 size = simple_strtoul(str, NULL, 10) * 1024;
 173                 if ((size != 0 && size < 8192) || size > substream->dma_max) {
 174                         buffer->error = -EINVAL;
 175                         return;
 176                 }
 177                 if (substream->dma_buffer.bytes == size)
 178                         return;
 179                 memset(&new_dmab, 0, sizeof(new_dmab));
 180                 new_dmab.dev = substream->dma_buffer.dev;
 181                 if (size > 0) {
 182                         if (do_alloc_pages(card,
 183                                            substream->dma_buffer.dev.type,
 184                                            substream->dma_buffer.dev.dev,
 185                                            substream->stream,
 186                                            size, &new_dmab) < 0) {
 187                                 buffer->error = -ENOMEM;
 188                                 pr_debug("ALSA pcmC%dD%d%c,%d:%s: cannot preallocate for size %zu\n",
 189                                          substream->pcm->card->number, substream->pcm->device,
 190                                          substream->stream ? 'c' : 'p', substream->number,
 191                                          substream->pcm->name, size);
 192                                 return;
 193                         }
 194                         substream->buffer_bytes_max = size;
 195                 } else {
 196                         substream->buffer_bytes_max = UINT_MAX;
 197                 }
 198                 if (substream->dma_buffer.area)
 199                         do_free_pages(card, &substream->dma_buffer);
 200                 substream->dma_buffer = new_dmab;
 201         } else {
 202                 buffer->error = -EINVAL;
 203         }
 204 }
 205
 206 static inline void preallocate_info_init(struct snd_pcm_substream *substream)
 207 {
 208         struct snd_info_entry *entry;
 209
 210         entry = snd_info_create_card_entry(substream->pcm->card, "prealloc",
 211                                            substream->proc_root);
 212         if (entry) {
 213                 snd_info_set_text_ops(entry, substream,
 214                                       snd_pcm_lib_preallocate_proc_read);
 215                 entry->c.text.write = snd_pcm_lib_preallocate_proc_write;
 216                 entry->mode |= 0200;
 217         }
 218         entry = snd_info_create_card_entry(substream->pcm->card, "prealloc_max",
 219                                            substream->proc_root);
 220         if (entry)
 221                 snd_info_set_text_ops(entry, substream,
 222                                       snd_pcm_lib_preallocate_max_proc_read);
 223 }
 224
 225 #else /* !CONFIG_SND_VERBOSE_PROCFS */
 226 static inline void preallocate_info_init(struct snd_pcm_substream *substream)
 227 {
 228 }
 229 #endif /* CONFIG_SND_VERBOSE_PROCFS */
 230
 231 /*
 232  * pre-allocate the buffer and create a proc file for the substream
 233  */
 234 static int preallocate_pages(struct snd_pcm_substream *substream,
 235                               int type, struct device *data,
 236                               size_t size, size_t max, bool managed)
 237 {
 238         int err;
 239
 240         if (snd_BUG_ON(substream->dma_buffer.dev.type))
 241                 return -EINVAL;
 242
 243         substream->dma_buffer.dev.type = type;
 244         substream->dma_buffer.dev.dev = data;
 245
 246         if (size > 0) {
 247                 if (!max) {
 248                         /* no fallback, only also inform -ENOMEM */
 249                         err = preallocate_pcm_pages(substream, size, true);
 250                         if (err < 0)
 251                                 return err;
 252                 } else if (preallocate_dma &&
 253                            substream->number < maximum_substreams) {
 254                         err = preallocate_pcm_pages(substream, size, false);
 255                         if (err < 0 && err != -ENOMEM)
 256                                 return err;
 257                 }
 258         }
 259
 260         if (substream->dma_buffer.bytes > 0)
 261                 substream->buffer_bytes_max = substream->dma_buffer.bytes;
 262         substream->dma_max = max;
 263         if (max > 0)
 264                 preallocate_info_init(substream);
 265         if (managed)
 266                 substream->managed_buffer_alloc = 1;
 267         return 0;
 268 }
 269
 270 static int preallocate_pages_for_all(struct snd_pcm *pcm, int type,
 271                                       void *data, size_t size, size_t max,
 272                                       bool managed)
 273 {
 274         struct snd_pcm_substream *substream;
 275         int stream, err;
 276
 277         for_each_pcm_substream(pcm, stream, substream) {
 278                 err = preallocate_pages(substream, type, data, size, max, managed);
 279                 if (err < 0)
 280                         return err;
 281         }
 282         return 0;
 283 }
 284
 285 /**
 286  * snd_pcm_lib_preallocate_pages - pre-allocation for the given DMA type
 287  * @substream: the pcm substream instance
 288  * @type: DMA type (SNDRV_DMA_TYPE_*)
 289  * @data: DMA type dependent data
 290  * @size: the requested pre-allocation size in bytes
 291  * @max: the max. allowed pre-allocation size
 292  *
 293  * Do pre-allocation for the given DMA buffer type.
 294  */
 295 void snd_pcm_lib_preallocate_pages(struct snd_pcm_substream *substream,
 296                                   int type, struct device *data,
 297                                   size_t size, size_t max)
 298 {
 299         preallocate_pages(substream, type, data, size, max, false);
 300 }
 301 EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages);
 302
 303 /**
 304  * snd_pcm_lib_preallocate_pages_for_all - pre-allocation for continuous memory type (all substreams)
 305  * @pcm: the pcm instance
 306  * @type: DMA type (SNDRV_DMA_TYPE_*)
 307  * @data: DMA type dependent data
 308  * @size: the requested pre-allocation size in bytes
 309  * @max: the max. allowed pre-allocation size
 310  *
 311  * Do pre-allocation to all substreams of the given pcm for the
 312  * specified DMA type.
 313  */
 314 void snd_pcm_lib_preallocate_pages_for_all(struct snd_pcm *pcm,
 315                                           int type, void *data,
 316                                           size_t size, size_t max)
 317 {
 318         preallocate_pages_for_all(pcm, type, data, size, max, false);
 319 }
 320 EXPORT_SYMBOL(snd_pcm_lib_preallocate_pages_for_all);
 321
 322 /**
 323  * snd_pcm_set_managed_buffer - set up buffer management for a substream
 324  * @substream: the pcm substream instance
 325  * @type: DMA type (SNDRV_DMA_TYPE_*)
 326  * @data: DMA type dependent data
 327  * @size: the requested pre-allocation size in bytes
 328  * @max: the max. allowed pre-allocation size
 329  *
 330  * Do pre-allocation for the given DMA buffer type, and set the managed
 331  * buffer allocation mode to the given substream.
 332  * In this mode, PCM core will allocate a buffer automatically before PCM
 333  * hw_params ops call, and release the buffer after PCM hw_free ops call
 334  * as well, so that the driver doesn't need to invoke the allocation and
 335  * the release explicitly in its callback.
 336  * When a buffer is actually allocated before the PCM hw_params call, it
 337  * turns on the runtime buffer_changed flag for drivers changing their h/w
 338  * parameters accordingly.
 339  *
 340  * When @size is non-zero and @max is zero, this tries to allocate for only
 341  * the exact buffer size without fallback, and may return -ENOMEM.
 342  * Otherwise, the function tries to allocate smaller chunks if the allocation
 343  * fails.  This is the behavior of snd_pcm_set_fixed_buffer().
 344  *
 345  * When both @size and @max are zero, the function only sets up the buffer
 346  * for later dynamic allocations. It's used typically for buffers with
 347  * SNDRV_DMA_TYPE_VMALLOC type.
 348  *
 349  * Upon successful buffer allocation and setup, the function returns 0.
 350  */
 351 int snd_pcm_set_managed_buffer(struct snd_pcm_substream *substream, int type,
 352                                 struct device *data, size_t size, size_t max)
 353 {
 354         return preallocate_pages(substream, type, data, size, max, true);
 355 }
 356 EXPORT_SYMBOL(snd_pcm_set_managed_buffer);
 357
 358 /**
 359  * snd_pcm_set_managed_buffer_all - set up buffer management for all substreams
 360  *      for all substreams
 361  * @pcm: the pcm instance
 362  * @type: DMA type (SNDRV_DMA_TYPE_*)
 363  * @data: DMA type dependent data
 364  * @size: the requested pre-allocation size in bytes
 365  * @max: the max. allowed pre-allocation size
 366  *
 367  * Do pre-allocation to all substreams of the given pcm for the specified DMA
 368  * type and size, and set the managed_buffer_alloc flag to each substream.
 369  */
 370 int snd_pcm_set_managed_buffer_all(struct snd_pcm *pcm, int type,
 371                                    struct device *data,
 372                                    size_t size, size_t max)
 373 {
 374         return preallocate_pages_for_all(pcm, type, data, size, max, true);
 375 }
 376 EXPORT_SYMBOL(snd_pcm_set_managed_buffer_all);
 377
 378 /**
 379  * snd_pcm_lib_malloc_pages - allocate the DMA buffer
 380  * @substream: the substream to allocate the DMA buffer to
 381  * @size: the requested buffer size in bytes
 382  *
 383  * Allocates the DMA buffer on the BUS type given earlier to
 384  * snd_pcm_lib_preallocate_xxx_pages().
 385  *
 386  * Return: 1 if the buffer is changed, 0 if not changed, or a negative
 387  * code on failure.
 388  */
 389 int snd_pcm_lib_malloc_pages(struct snd_pcm_substream *substream, size_t size)
 390 {
 391         struct snd_card *card;
 392         struct snd_pcm_runtime *runtime;
 393         struct snd_dma_buffer *dmab = NULL;
 394
 395         if (PCM_RUNTIME_CHECK(substream))
 396                 return -EINVAL;
 397         if (snd_BUG_ON(substream->dma_buffer.dev.type ==
 398                        SNDRV_DMA_TYPE_UNKNOWN))
 399                 return -EINVAL;
 400         runtime = substream->runtime;
 401         card = substream->pcm->card;
 402
 403         if (runtime->dma_buffer_p) {
 404                 /* perphaps, we might free the large DMA memory region
 405                    to save some space here, but the actual solution
 406                    costs us less time */
 407                 if (runtime->dma_buffer_p->bytes >= size) {
 408                         runtime->dma_bytes = size;
 409                         return 0;       /* ok, do not change */
 410                 }
 411                 snd_pcm_lib_free_pages(substream);
 412         }
 413         if (substream->dma_buffer.area != NULL &&
 414             substream->dma_buffer.bytes >= size) {
 415                 dmab = &substream->dma_buffer; /* use the pre-allocated buffer */
 416         } else {
 417                 /* dma_max=0 means the fixed size preallocation */
 418                 if (substream->dma_buffer.area && !substream->dma_max)
 419                         return -ENOMEM;
 420                 dmab = kzalloc(sizeof(*dmab), GFP_KERNEL);
 421                 if (! dmab)
 422                         return -ENOMEM;
 423                 dmab->dev = substream->dma_buffer.dev;
 424                 if (do_alloc_pages(card,
 425                                    substream->dma_buffer.dev.type,
 426                                    substream->dma_buffer.dev.dev,
 427                                    substream->stream,
 428                                    size, dmab) < 0) {
 429                         kfree(dmab);
 430                         pr_debug("ALSA pcmC%dD%d%c,%d:%s: cannot preallocate for size %zu\n",
 431                                  substream->pcm->card->number, substream->pcm->device,
 432                                  substream->stream ? 'c' : 'p', substream->number,
 433                                  substream->pcm->name, size);
 434                         return -ENOMEM;
 435                 }
 436         }
 437         snd_pcm_set_runtime_buffer(substream, dmab);
 438         runtime->dma_bytes = size;
 439         return 1;                       /* area was changed */
 440 }
 441 EXPORT_SYMBOL(snd_pcm_lib_malloc_pages);
 442
 443 /**
 444  * snd_pcm_lib_free_pages - release the allocated DMA buffer.
 445  * @substream: the substream to release the DMA buffer
 446  *
 447  * Releases the DMA buffer allocated via snd_pcm_lib_malloc_pages().
 448  *
 449  * Return: Zero if successful, or a negative error code on failure.
 450  */
 451 int snd_pcm_lib_free_pages(struct snd_pcm_substream *substream)
 452 {
 453         struct snd_card *card = substream->pcm->card;
 454         struct snd_pcm_runtime *runtime;
 455
 456         if (PCM_RUNTIME_CHECK(substream))
 457                 return -EINVAL;
 458         runtime = substream->runtime;
 459         if (runtime->dma_area == NULL)
 460                 return 0;
 461         if (runtime->dma_buffer_p != &substream->dma_buffer) {
 462                 /* it's a newly allocated buffer.  release it now. */
 463                 do_free_pages(card, runtime->dma_buffer_p);
 464                 kfree(runtime->dma_buffer_p);
 465         }
 466         snd_pcm_set_runtime_buffer(substream, NULL);
 467         return 0;
 468 }
 469 EXPORT_SYMBOL(snd_pcm_lib_free_pages);
 470
 471 int _snd_pcm_lib_alloc_vmalloc_buffer(struct snd_pcm_substream *substream,
 472                                       size_t size, gfp_t gfp_flags)
 473 {
 474         struct snd_pcm_runtime *runtime;
 475
 476         if (PCM_RUNTIME_CHECK(substream))
 477                 return -EINVAL;
 478         runtime = substream->runtime;
 479         if (runtime->dma_area) {
 480                 if (runtime->dma_bytes >= size)
 481                         return 0; /* already large enough */
 482                 vfree(runtime->dma_area);
 483         }
 484         runtime->dma_area = __vmalloc(size, gfp_flags);
 485         if (!runtime->dma_area)
 486                 return -ENOMEM;
 487         runtime->dma_bytes = size;
 488         return 1;
 489 }
 490 EXPORT_SYMBOL(_snd_pcm_lib_alloc_vmalloc_buffer);
 491
 492 /**
 493  * snd_pcm_lib_free_vmalloc_buffer - free vmalloc buffer
 494  * @substream: the substream with a buffer allocated by
 495  *      snd_pcm_lib_alloc_vmalloc_buffer()
 496  *
 497  * Return: Zero if successful, or a negative error code on failure.
 498  */
 499 int snd_pcm_lib_free_vmalloc_buffer(struct snd_pcm_substream *substream)
 500 {
 501         struct snd_pcm_runtime *runtime;
 502
 503         if (PCM_RUNTIME_CHECK(substream))
 504                 return -EINVAL;
 505         runtime = substream->runtime;
 506         vfree(runtime->dma_area);
 507         runtime->dma_area = NULL;
 508         return 0;
 509 }
 510 EXPORT_SYMBOL(snd_pcm_lib_free_vmalloc_buffer);
 511
 512 /**
 513  * snd_pcm_lib_get_vmalloc_page - map vmalloc buffer offset to page struct
 514  * @substream: the substream with a buffer allocated by
 515  *      snd_pcm_lib_alloc_vmalloc_buffer()
 516  * @offset: offset in the buffer
 517  *
 518  * This function is to be used as the page callback in the PCM ops.
 519  *
 520  * Return: The page struct, or %NULL on failure.
 521  */
 522 struct page *snd_pcm_lib_get_vmalloc_page(struct snd_pcm_substream *substream,
 523                                           unsigned long offset)
 524 {
 525         return vmalloc_to_page(substream->runtime->dma_area + offset);
 526 }
 527 EXPORT_SYMBOL(snd_pcm_lib_get_vmalloc_page);