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