mm/dmapool.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * DMA Pool allocator
   4  *
   5  * Copyright 2001 David Brownell
   6  * Copyright 2007 Intel Corporation
   7  *   Author: Matthew Wilcox <willy@linux.intel.com>
   8  *
   9  * This allocator returns small blocks of a given size which are DMA-able by
  10  * the given device.  It uses the dma_alloc_coherent page allocator to get
  11  * new pages, then splits them up into blocks of the required size.
  12  * Many older drivers still have their own code to do this.
  13  *
  14  * The current design of this allocator is fairly simple.  The pool is
  15  * represented by the 'struct dma_pool' which keeps a doubly-linked list of
  16  * allocated pages.  Each page in the page_list is split into blocks of at
  17  * least 'size' bytes.  Free blocks are tracked in an unsorted singly-linked
  18  * list of free blocks within the page.  Used blocks aren't tracked, but we
  19  * keep a count of how many are currently allocated from each page.
  20  */
  21
  22 #include <linux/device.h>
  23 #include <linux/dma-mapping.h>
  24 #include <linux/dmapool.h>
  25 #include <linux/kernel.h>
  26 #include <linux/list.h>
  27 #include <linux/export.h>
  28 #include <linux/mutex.h>
  29 #include <linux/poison.h>
  30 #include <linux/sched.h>
  31 #include <linux/sched/mm.h>
  32 #include <linux/slab.h>
  33 #include <linux/stat.h>
  34 #include <linux/spinlock.h>
  35 #include <linux/string.h>
  36 #include <linux/types.h>
  37 #include <linux/wait.h>
  38
  39 #if defined(CONFIG_DEBUG_SLAB) || defined(CONFIG_SLUB_DEBUG_ON)
  40 #define DMAPOOL_DEBUG 1
  41 #endif
  42
  43 struct dma_pool {               /* the pool */
  44         struct list_head page_list;
  45         spinlock_t lock;
  46         size_t size;
  47         struct device *dev;
  48         size_t allocation;
  49         size_t boundary;
  50         char name[32];
  51         struct list_head pools;
  52 };
  53
  54 struct dma_page {               /* cacheable header for 'allocation' bytes */
  55         struct list_head page_list;
  56         void *vaddr;
  57         dma_addr_t dma;
  58         unsigned int in_use;
  59         unsigned int offset;
  60 };
  61
  62 static DEFINE_MUTEX(pools_lock);
  63 static DEFINE_MUTEX(pools_reg_lock);
  64
  65 static ssize_t pools_show(struct device *dev, struct device_attribute *attr, char *buf)
  66 {
  67         unsigned temp;
  68         unsigned size;
  69         char *next;
  70         struct dma_page *page;
  71         struct dma_pool *pool;
  72
  73         next = buf;
  74         size = PAGE_SIZE;
  75
  76         temp = scnprintf(next, size, "poolinfo - 0.1\n");
  77         size -= temp;
  78         next += temp;
  79
  80         mutex_lock(&pools_lock);
  81         list_for_each_entry(pool, &dev->dma_pools, pools) {
  82                 unsigned pages = 0;
  83                 unsigned blocks = 0;
  84
  85                 spin_lock_irq(&pool->lock);
  86                 list_for_each_entry(page, &pool->page_list, page_list) {
  87                         pages++;
  88                         blocks += page->in_use;
  89                 }
  90                 spin_unlock_irq(&pool->lock);
  91
  92                 /* per-pool info, no real statistics yet */
  93                 temp = scnprintf(next, size, "%-16s %4u %4zu %4zu %2u\n",
  94                                  pool->name, blocks,
  95                                  pages * (pool->allocation / pool->size),
  96                                  pool->size, pages);
  97                 size -= temp;
  98                 next += temp;
  99         }
 100         mutex_unlock(&pools_lock);
 101
 102         return PAGE_SIZE - size;
 103 }
 104
 105 static DEVICE_ATTR_RO(pools);
 106
 107 /**
 108  * dma_pool_create - Creates a pool of consistent memory blocks, for dma.
 109  * @name: name of pool, for diagnostics
 110  * @dev: device that will be doing the DMA
 111  * @size: size of the blocks in this pool.
 112  * @align: alignment requirement for blocks; must be a power of two
 113  * @boundary: returned blocks won't cross this power of two boundary
 114  * Context: not in_interrupt()
 115  *
 116  * Given one of these pools, dma_pool_alloc()
 117  * may be used to allocate memory.  Such memory will all have "consistent"
 118  * DMA mappings, accessible by the device and its driver without using
 119  * cache flushing primitives.  The actual size of blocks allocated may be
 120  * larger than requested because of alignment.
 121  *
 122  * If @boundary is nonzero, objects returned from dma_pool_alloc() won't
 123  * cross that size boundary.  This is useful for devices which have
 124  * addressing restrictions on individual DMA transfers, such as not crossing
 125  * boundaries of 4KBytes.
 126  *
 127  * Return: a dma allocation pool with the requested characteristics, or
 128  * %NULL if one can't be created.
 129  */
 130 struct dma_pool *dma_pool_create(const char *name, struct device *dev,
 131                                  size_t size, size_t align, size_t boundary)
 132 {
 133         struct dma_pool *retval;
 134         size_t allocation;
 135         bool empty = false;
 136
 137         if (!dev)
 138                 return NULL;
 139
 140         if (align == 0)
 141                 align = 1;
 142         else if (align & (align - 1))
 143                 return NULL;
 144
 145         if (size == 0)
 146                 return NULL;
 147         else if (size < 4)
 148                 size = 4;
 149
 150         size = ALIGN(size, align);
 151         allocation = max_t(size_t, size, PAGE_SIZE);
 152
 153         if (!boundary)
 154                 boundary = allocation;
 155         else if ((boundary < size) || (boundary & (boundary - 1)))
 156                 return NULL;
 157
 158         retval = kmalloc(sizeof(*retval), GFP_KERNEL);
 159         if (!retval)
 160                 return retval;
 161
 162         strscpy(retval->name, name, sizeof(retval->name));
 163
 164         retval->dev = dev;
 165
 166         INIT_LIST_HEAD(&retval->page_list);
 167         spin_lock_init(&retval->lock);
 168         retval->size = size;
 169         retval->boundary = boundary;
 170         retval->allocation = allocation;
 171
 172         INIT_LIST_HEAD(&retval->pools);
 173
 174         /*
 175          * pools_lock ensures that the ->dma_pools list does not get corrupted.
 176          * pools_reg_lock ensures that there is not a race between
 177          * dma_pool_create() and dma_pool_destroy() or within dma_pool_create()
 178          * when the first invocation of dma_pool_create() failed on
 179          * device_create_file() and the second assumes that it has been done (I
 180          * know it is a short window).
 181          */
 182         mutex_lock(&pools_reg_lock);
 183         mutex_lock(&pools_lock);
 184         if (list_empty(&dev->dma_pools))
 185                 empty = true;
 186         list_add(&retval->pools, &dev->dma_pools);
 187         mutex_unlock(&pools_lock);
 188         if (empty) {
 189                 int err;
 190
 191                 err = device_create_file(dev, &dev_attr_pools);
 192                 if (err) {
 193                         mutex_lock(&pools_lock);
 194                         list_del(&retval->pools);
 195                         mutex_unlock(&pools_lock);
 196                         mutex_unlock(&pools_reg_lock);
 197                         kfree(retval);
 198                         return NULL;
 199                 }
 200         }
 201         mutex_unlock(&pools_reg_lock);
 202         return retval;
 203 }
 204 EXPORT_SYMBOL(dma_pool_create);
 205
 206 static void pool_initialise_page(struct dma_pool *pool, struct dma_page *page)
 207 {
 208         unsigned int offset = 0;
 209         unsigned int next_boundary = pool->boundary;
 210
 211         do {
 212                 unsigned int next = offset + pool->size;
 213                 if (unlikely((next + pool->size) >= next_boundary)) {
 214                         next = next_boundary;
 215                         next_boundary += pool->boundary;
 216                 }
 217                 *(int *)(page->vaddr + offset) = next;
 218                 offset = next;
 219         } while (offset < pool->allocation);
 220 }
 221
 222 static struct dma_page *pool_alloc_page(struct dma_pool *pool, gfp_t mem_flags)
 223 {
 224         struct dma_page *page;
 225
 226         page = kmalloc(sizeof(*page), mem_flags);
 227         if (!page)
 228                 return NULL;
 229         page->vaddr = dma_alloc_coherent(pool->dev, pool->allocation,
 230                                          &page->dma, mem_flags);
 231         if (page->vaddr) {
 232 #ifdef  DMAPOOL_DEBUG
 233                 memset(page->vaddr, POOL_POISON_FREED, pool->allocation);
 234 #endif
 235                 pool_initialise_page(pool, page);
 236                 page->in_use = 0;
 237                 page->offset = 0;
 238         } else {
 239                 kfree(page);
 240                 page = NULL;
 241         }
 242         return page;
 243 }
 244
 245 static inline bool is_page_busy(struct dma_page *page)
 246 {
 247         return page->in_use != 0;
 248 }
 249
 250 static void pool_free_page(struct dma_pool *pool, struct dma_page *page)
 251 {
 252         dma_addr_t dma = page->dma;
 253
 254 #ifdef  DMAPOOL_DEBUG
 255         memset(page->vaddr, POOL_POISON_FREED, pool->allocation);
 256 #endif
 257         dma_free_coherent(pool->dev, pool->allocation, page->vaddr, dma);
 258         list_del(&page->page_list);
 259         kfree(page);
 260 }
 261
 262 /**
 263  * dma_pool_destroy - destroys a pool of dma memory blocks.
 264  * @pool: dma pool that will be destroyed
 265  * Context: !in_interrupt()
 266  *
 267  * Caller guarantees that no more memory from the pool is in use,
 268  * and that nothing will try to use the pool after this call.
 269  */
 270 void dma_pool_destroy(struct dma_pool *pool)
 271 {
 272         struct dma_page *page, *tmp;
 273         bool empty = false;
 274
 275         if (unlikely(!pool))
 276                 return;
 277
 278         mutex_lock(&pools_reg_lock);
 279         mutex_lock(&pools_lock);
 280         list_del(&pool->pools);
 281         if (list_empty(&pool->dev->dma_pools))
 282                 empty = true;
 283         mutex_unlock(&pools_lock);
 284         if (empty)
 285                 device_remove_file(pool->dev, &dev_attr_pools);
 286         mutex_unlock(&pools_reg_lock);
 287
 288         list_for_each_entry_safe(page, tmp, &pool->page_list, page_list) {
 289                 if (is_page_busy(page)) {
 290                         dev_err(pool->dev, "%s %s, %p busy\n", __func__,
 291                                 pool->name, page->vaddr);
 292                         /* leak the still-in-use consistent memory */
 293                         list_del(&page->page_list);
 294                         kfree(page);
 295                 } else
 296                         pool_free_page(pool, page);
 297         }
 298
 299         kfree(pool);
 300 }
 301 EXPORT_SYMBOL(dma_pool_destroy);
 302
 303 /**
 304  * dma_pool_alloc - get a block of consistent memory
 305  * @pool: dma pool that will produce the block
 306  * @mem_flags: GFP_* bitmask
 307  * @handle: pointer to dma address of block
 308  *
 309  * Return: the kernel virtual address of a currently unused block,
 310  * and reports its dma address through the handle.
 311  * If such a memory block can't be allocated, %NULL is returned.
 312  */
 313 void *dma_pool_alloc(struct dma_pool *pool, gfp_t mem_flags,
 314                      dma_addr_t *handle)
 315 {
 316         unsigned long flags;
 317         struct dma_page *page;
 318         size_t offset;
 319         void *retval;
 320
 321         might_alloc(mem_flags);
 322
 323         spin_lock_irqsave(&pool->lock, flags);
 324         list_for_each_entry(page, &pool->page_list, page_list) {
 325                 if (page->offset < pool->allocation)
 326                         goto ready;
 327         }
 328
 329         /* pool_alloc_page() might sleep, so temporarily drop &pool->lock */
 330         spin_unlock_irqrestore(&pool->lock, flags);
 331
 332         page = pool_alloc_page(pool, mem_flags & (~__GFP_ZERO));
 333         if (!page)
 334                 return NULL;
 335
 336         spin_lock_irqsave(&pool->lock, flags);
 337
 338         list_add(&page->page_list, &pool->page_list);
 339  ready:
 340         page->in_use++;
 341         offset = page->offset;
 342         page->offset = *(int *)(page->vaddr + offset);
 343         retval = offset + page->vaddr;
 344         *handle = offset + page->dma;
 345 #ifdef  DMAPOOL_DEBUG
 346         {
 347                 int i;
 348                 u8 *data = retval;
 349                 /* page->offset is stored in first 4 bytes */
 350                 for (i = sizeof(page->offset); i < pool->size; i++) {
 351                         if (data[i] == POOL_POISON_FREED)
 352                                 continue;
 353                         dev_err(pool->dev, "%s %s, %p (corrupted)\n",
 354                                 __func__, pool->name, retval);
 355
 356                         /*
 357                          * Dump the first 4 bytes even if they are not
 358                          * POOL_POISON_FREED
 359                          */
 360                         print_hex_dump(KERN_ERR, "", DUMP_PREFIX_OFFSET, 16, 1,
 361                                         data, pool->size, 1);
 362                         break;
 363                 }
 364         }
 365         if (!(mem_flags & __GFP_ZERO))
 366                 memset(retval, POOL_POISON_ALLOCATED, pool->size);
 367 #endif
 368         spin_unlock_irqrestore(&pool->lock, flags);
 369
 370         if (want_init_on_alloc(mem_flags))
 371                 memset(retval, 0, pool->size);
 372
 373         return retval;
 374 }
 375 EXPORT_SYMBOL(dma_pool_alloc);
 376
 377 static struct dma_page *pool_find_page(struct dma_pool *pool, dma_addr_t dma)
 378 {
 379         struct dma_page *page;
 380
 381         list_for_each_entry(page, &pool->page_list, page_list) {
 382                 if (dma < page->dma)
 383                         continue;
 384                 if ((dma - page->dma) < pool->allocation)
 385                         return page;
 386         }
 387         return NULL;
 388 }
 389
 390 /**
 391  * dma_pool_free - put block back into dma pool
 392  * @pool: the dma pool holding the block
 393  * @vaddr: virtual address of block
 394  * @dma: dma address of block
 395  *
 396  * Caller promises neither device nor driver will again touch this block
 397  * unless it is first re-allocated.
 398  */
 399 void dma_pool_free(struct dma_pool *pool, void *vaddr, dma_addr_t dma)
 400 {
 401         struct dma_page *page;
 402         unsigned long flags;
 403         unsigned int offset;
 404
 405         spin_lock_irqsave(&pool->lock, flags);
 406         page = pool_find_page(pool, dma);
 407         if (!page) {
 408                 spin_unlock_irqrestore(&pool->lock, flags);
 409                 dev_err(pool->dev, "%s %s, %p/%pad (bad dma)\n",
 410                         __func__, pool->name, vaddr, &dma);
 411                 return;
 412         }
 413
 414         offset = vaddr - page->vaddr;
 415         if (want_init_on_free())
 416                 memset(vaddr, 0, pool->size);
 417 #ifdef  DMAPOOL_DEBUG
 418         if ((dma - page->dma) != offset) {
 419                 spin_unlock_irqrestore(&pool->lock, flags);
 420                 dev_err(pool->dev, "%s %s, %p (bad vaddr)/%pad\n",
 421                         __func__, pool->name, vaddr, &dma);
 422                 return;
 423         }
 424         {
 425                 unsigned int chain = page->offset;
 426                 while (chain < pool->allocation) {
 427                         if (chain != offset) {
 428                                 chain = *(int *)(page->vaddr + chain);
 429                                 continue;
 430                         }
 431                         spin_unlock_irqrestore(&pool->lock, flags);
 432                         dev_err(pool->dev, "%s %s, dma %pad already free\n",
 433                                 __func__, pool->name, &dma);
 434                         return;
 435                 }
 436         }
 437         memset(vaddr, POOL_POISON_FREED, pool->size);
 438 #endif
 439
 440         page->in_use--;
 441         *(int *)vaddr = page->offset;
 442         page->offset = offset;
 443         /*
 444          * Resist a temptation to do
 445          *    if (!is_page_busy(page)) pool_free_page(pool, page);
 446          * Better have a few empty pages hang around.
 447          */
 448         spin_unlock_irqrestore(&pool->lock, flags);
 449 }
 450 EXPORT_SYMBOL(dma_pool_free);
 451
 452 /*
 453  * Managed DMA pool
 454  */
 455 static void dmam_pool_release(struct device *dev, void *res)
 456 {
 457         struct dma_pool *pool = *(struct dma_pool **)res;
 458
 459         dma_pool_destroy(pool);
 460 }
 461
 462 static int dmam_pool_match(struct device *dev, void *res, void *match_data)
 463 {
 464         return *(struct dma_pool **)res == match_data;
 465 }
 466
 467 /**
 468  * dmam_pool_create - Managed dma_pool_create()
 469  * @name: name of pool, for diagnostics
 470  * @dev: device that will be doing the DMA
 471  * @size: size of the blocks in this pool.
 472  * @align: alignment requirement for blocks; must be a power of two
 473  * @allocation: returned blocks won't cross this boundary (or zero)
 474  *
 475  * Managed dma_pool_create().  DMA pool created with this function is
 476  * automatically destroyed on driver detach.
 477  *
 478  * Return: a managed dma allocation pool with the requested
 479  * characteristics, or %NULL if one can't be created.
 480  */
 481 struct dma_pool *dmam_pool_create(const char *name, struct device *dev,
 482                                   size_t size, size_t align, size_t allocation)
 483 {
 484         struct dma_pool **ptr, *pool;
 485
 486         ptr = devres_alloc(dmam_pool_release, sizeof(*ptr), GFP_KERNEL);
 487         if (!ptr)
 488                 return NULL;
 489
 490         pool = *ptr = dma_pool_create(name, dev, size, align, allocation);
 491         if (pool)
 492                 devres_add(dev, ptr);
 493         else
 494                 devres_free(ptr);
 495
 496         return pool;
 497 }
 498 EXPORT_SYMBOL(dmam_pool_create);
 499
 500 /**
 501  * dmam_pool_destroy - Managed dma_pool_destroy()
 502  * @pool: dma pool that will be destroyed
 503  *
 504  * Managed dma_pool_destroy().
 505  */
 506 void dmam_pool_destroy(struct dma_pool *pool)
 507 {
 508         struct device *dev = pool->dev;
 509
 510         WARN_ON(devres_release(dev, dmam_pool_release, dmam_pool_match, pool));
 511 }
 512 EXPORT_SYMBOL(dmam_pool_destroy);