Merge branch 'asoc-4.17' into asoc-4.18 merge window
[sfrench/cifs-2.6.git] / drivers / gpu / drm / ttm / ttm_page_alloc_dma.c
1 /*
2  * Copyright 2011 (c) Oracle Corp.
3
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sub license,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the
12  * next paragraph) shall be included in all copies or substantial portions
13  * of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  *
23  * Author: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
24  */
25
26 /*
27  * A simple DMA pool losely based on dmapool.c. It has certain advantages
28  * over the DMA pools:
29  * - Pool collects resently freed pages for reuse (and hooks up to
30  *   the shrinker).
31  * - Tracks currently in use pages
32  * - Tracks whether the page is UC, WB or cached (and reverts to WB
33  *   when freed).
34  */
35
36 #if defined(CONFIG_SWIOTLB) || defined(CONFIG_INTEL_IOMMU)
37 #define pr_fmt(fmt) "[TTM] " fmt
38
39 #include <linux/dma-mapping.h>
40 #include <linux/list.h>
41 #include <linux/seq_file.h> /* for seq_printf */
42 #include <linux/slab.h>
43 #include <linux/spinlock.h>
44 #include <linux/highmem.h>
45 #include <linux/mm_types.h>
46 #include <linux/module.h>
47 #include <linux/mm.h>
48 #include <linux/atomic.h>
49 #include <linux/device.h>
50 #include <linux/kthread.h>
51 #include <drm/ttm/ttm_bo_driver.h>
52 #include <drm/ttm/ttm_page_alloc.h>
53 #if IS_ENABLED(CONFIG_AGP)
54 #include <asm/agp.h>
55 #endif
56 #ifdef CONFIG_X86
57 #include <asm/set_memory.h>
58 #endif
59
60 #define NUM_PAGES_TO_ALLOC              (PAGE_SIZE/sizeof(struct page *))
61 #define SMALL_ALLOCATION                4
62 #define FREE_ALL_PAGES                  (~0U)
63 #define VADDR_FLAG_HUGE_POOL            1UL
64 #define VADDR_FLAG_UPDATED_COUNT        2UL
65
66 enum pool_type {
67         IS_UNDEFINED    = 0,
68         IS_WC           = 1 << 1,
69         IS_UC           = 1 << 2,
70         IS_CACHED       = 1 << 3,
71         IS_DMA32        = 1 << 4,
72         IS_HUGE         = 1 << 5
73 };
74
75 /*
76  * The pool structure. There are up to nine pools:
77  *  - generic (not restricted to DMA32):
78  *      - write combined, uncached, cached.
79  *  - dma32 (up to 2^32 - so up 4GB):
80  *      - write combined, uncached, cached.
81  *  - huge (not restricted to DMA32):
82  *      - write combined, uncached, cached.
83  * for each 'struct device'. The 'cached' is for pages that are actively used.
84  * The other ones can be shrunk by the shrinker API if neccessary.
85  * @pools: The 'struct device->dma_pools' link.
86  * @type: Type of the pool
87  * @lock: Protects the free_list from concurrnet access. Must be
88  * used with irqsave/irqrestore variants because pool allocator maybe called
89  * from delayed work.
90  * @free_list: Pool of pages that are free to be used. No order requirements.
91  * @dev: The device that is associated with these pools.
92  * @size: Size used during DMA allocation.
93  * @npages_free: Count of available pages for re-use.
94  * @npages_in_use: Count of pages that are in use.
95  * @nfrees: Stats when pool is shrinking.
96  * @nrefills: Stats when the pool is grown.
97  * @gfp_flags: Flags to pass for alloc_page.
98  * @name: Name of the pool.
99  * @dev_name: Name derieved from dev - similar to how dev_info works.
100  *   Used during shutdown as the dev_info during release is unavailable.
101  */
102 struct dma_pool {
103         struct list_head pools; /* The 'struct device->dma_pools link */
104         enum pool_type type;
105         spinlock_t lock;
106         struct list_head free_list;
107         struct device *dev;
108         unsigned size;
109         unsigned npages_free;
110         unsigned npages_in_use;
111         unsigned long nfrees; /* Stats when shrunk. */
112         unsigned long nrefills; /* Stats when grown. */
113         gfp_t gfp_flags;
114         char name[13]; /* "cached dma32" */
115         char dev_name[64]; /* Constructed from dev */
116 };
117
118 /*
119  * The accounting page keeping track of the allocated page along with
120  * the DMA address.
121  * @page_list: The link to the 'page_list' in 'struct dma_pool'.
122  * @vaddr: The virtual address of the page and a flag if the page belongs to a
123  * huge pool
124  * @dma: The bus address of the page. If the page is not allocated
125  *   via the DMA API, it will be -1.
126  */
127 struct dma_page {
128         struct list_head page_list;
129         unsigned long vaddr;
130         struct page *p;
131         dma_addr_t dma;
132 };
133
134 /*
135  * Limits for the pool. They are handled without locks because only place where
136  * they may change is in sysfs store. They won't have immediate effect anyway
137  * so forcing serialization to access them is pointless.
138  */
139
140 struct ttm_pool_opts {
141         unsigned        alloc_size;
142         unsigned        max_size;
143         unsigned        small;
144 };
145
146 /*
147  * Contains the list of all of the 'struct device' and their corresponding
148  * DMA pools. Guarded by _mutex->lock.
149  * @pools: The link to 'struct ttm_pool_manager->pools'
150  * @dev: The 'struct device' associated with the 'pool'
151  * @pool: The 'struct dma_pool' associated with the 'dev'
152  */
153 struct device_pools {
154         struct list_head pools;
155         struct device *dev;
156         struct dma_pool *pool;
157 };
158
159 /*
160  * struct ttm_pool_manager - Holds memory pools for fast allocation
161  *
162  * @lock: Lock used when adding/removing from pools
163  * @pools: List of 'struct device' and 'struct dma_pool' tuples.
164  * @options: Limits for the pool.
165  * @npools: Total amount of pools in existence.
166  * @shrinker: The structure used by [un|]register_shrinker
167  */
168 struct ttm_pool_manager {
169         struct mutex            lock;
170         struct list_head        pools;
171         struct ttm_pool_opts    options;
172         unsigned                npools;
173         struct shrinker         mm_shrink;
174         struct kobject          kobj;
175 };
176
177 static struct ttm_pool_manager *_manager;
178
179 static struct attribute ttm_page_pool_max = {
180         .name = "pool_max_size",
181         .mode = S_IRUGO | S_IWUSR
182 };
183 static struct attribute ttm_page_pool_small = {
184         .name = "pool_small_allocation",
185         .mode = S_IRUGO | S_IWUSR
186 };
187 static struct attribute ttm_page_pool_alloc_size = {
188         .name = "pool_allocation_size",
189         .mode = S_IRUGO | S_IWUSR
190 };
191
192 static struct attribute *ttm_pool_attrs[] = {
193         &ttm_page_pool_max,
194         &ttm_page_pool_small,
195         &ttm_page_pool_alloc_size,
196         NULL
197 };
198
199 static void ttm_pool_kobj_release(struct kobject *kobj)
200 {
201         struct ttm_pool_manager *m =
202                 container_of(kobj, struct ttm_pool_manager, kobj);
203         kfree(m);
204 }
205
206 static ssize_t ttm_pool_store(struct kobject *kobj, struct attribute *attr,
207                               const char *buffer, size_t size)
208 {
209         struct ttm_pool_manager *m =
210                 container_of(kobj, struct ttm_pool_manager, kobj);
211         int chars;
212         unsigned val;
213
214         chars = sscanf(buffer, "%u", &val);
215         if (chars == 0)
216                 return size;
217
218         /* Convert kb to number of pages */
219         val = val / (PAGE_SIZE >> 10);
220
221         if (attr == &ttm_page_pool_max) {
222                 m->options.max_size = val;
223         } else if (attr == &ttm_page_pool_small) {
224                 m->options.small = val;
225         } else if (attr == &ttm_page_pool_alloc_size) {
226                 if (val > NUM_PAGES_TO_ALLOC*8) {
227                         pr_err("Setting allocation size to %lu is not allowed. Recommended size is %lu\n",
228                                NUM_PAGES_TO_ALLOC*(PAGE_SIZE >> 7),
229                                NUM_PAGES_TO_ALLOC*(PAGE_SIZE >> 10));
230                         return size;
231                 } else if (val > NUM_PAGES_TO_ALLOC) {
232                         pr_warn("Setting allocation size to larger than %lu is not recommended\n",
233                                 NUM_PAGES_TO_ALLOC*(PAGE_SIZE >> 10));
234                 }
235                 m->options.alloc_size = val;
236         }
237
238         return size;
239 }
240
241 static ssize_t ttm_pool_show(struct kobject *kobj, struct attribute *attr,
242                              char *buffer)
243 {
244         struct ttm_pool_manager *m =
245                 container_of(kobj, struct ttm_pool_manager, kobj);
246         unsigned val = 0;
247
248         if (attr == &ttm_page_pool_max)
249                 val = m->options.max_size;
250         else if (attr == &ttm_page_pool_small)
251                 val = m->options.small;
252         else if (attr == &ttm_page_pool_alloc_size)
253                 val = m->options.alloc_size;
254
255         val = val * (PAGE_SIZE >> 10);
256
257         return snprintf(buffer, PAGE_SIZE, "%u\n", val);
258 }
259
260 static const struct sysfs_ops ttm_pool_sysfs_ops = {
261         .show = &ttm_pool_show,
262         .store = &ttm_pool_store,
263 };
264
265 static struct kobj_type ttm_pool_kobj_type = {
266         .release = &ttm_pool_kobj_release,
267         .sysfs_ops = &ttm_pool_sysfs_ops,
268         .default_attrs = ttm_pool_attrs,
269 };
270
271 #ifndef CONFIG_X86
272 static int set_pages_array_wb(struct page **pages, int addrinarray)
273 {
274 #if IS_ENABLED(CONFIG_AGP)
275         int i;
276
277         for (i = 0; i < addrinarray; i++)
278                 unmap_page_from_agp(pages[i]);
279 #endif
280         return 0;
281 }
282
283 static int set_pages_array_wc(struct page **pages, int addrinarray)
284 {
285 #if IS_ENABLED(CONFIG_AGP)
286         int i;
287
288         for (i = 0; i < addrinarray; i++)
289                 map_page_into_agp(pages[i]);
290 #endif
291         return 0;
292 }
293
294 static int set_pages_array_uc(struct page **pages, int addrinarray)
295 {
296 #if IS_ENABLED(CONFIG_AGP)
297         int i;
298
299         for (i = 0; i < addrinarray; i++)
300                 map_page_into_agp(pages[i]);
301 #endif
302         return 0;
303 }
304 #endif /* for !CONFIG_X86 */
305
306 static int ttm_set_pages_caching(struct dma_pool *pool,
307                                  struct page **pages, unsigned cpages)
308 {
309         int r = 0;
310         /* Set page caching */
311         if (pool->type & IS_UC) {
312                 r = set_pages_array_uc(pages, cpages);
313                 if (r)
314                         pr_err("%s: Failed to set %d pages to uc!\n",
315                                pool->dev_name, cpages);
316         }
317         if (pool->type & IS_WC) {
318                 r = set_pages_array_wc(pages, cpages);
319                 if (r)
320                         pr_err("%s: Failed to set %d pages to wc!\n",
321                                pool->dev_name, cpages);
322         }
323         return r;
324 }
325
326 static void __ttm_dma_free_page(struct dma_pool *pool, struct dma_page *d_page)
327 {
328         dma_addr_t dma = d_page->dma;
329         d_page->vaddr &= ~VADDR_FLAG_HUGE_POOL;
330         dma_free_coherent(pool->dev, pool->size, (void *)d_page->vaddr, dma);
331
332         kfree(d_page);
333         d_page = NULL;
334 }
335 static struct dma_page *__ttm_dma_alloc_page(struct dma_pool *pool)
336 {
337         struct dma_page *d_page;
338         unsigned long attrs = 0;
339         void *vaddr;
340
341         d_page = kmalloc(sizeof(struct dma_page), GFP_KERNEL);
342         if (!d_page)
343                 return NULL;
344
345         if (pool->type & IS_HUGE)
346                 attrs = DMA_ATTR_NO_WARN;
347
348         vaddr = dma_alloc_attrs(pool->dev, pool->size, &d_page->dma,
349                                 pool->gfp_flags, attrs);
350         if (vaddr) {
351                 if (is_vmalloc_addr(vaddr))
352                         d_page->p = vmalloc_to_page(vaddr);
353                 else
354                         d_page->p = virt_to_page(vaddr);
355                 d_page->vaddr = (unsigned long)vaddr;
356                 if (pool->type & IS_HUGE)
357                         d_page->vaddr |= VADDR_FLAG_HUGE_POOL;
358         } else {
359                 kfree(d_page);
360                 d_page = NULL;
361         }
362         return d_page;
363 }
364 static enum pool_type ttm_to_type(int flags, enum ttm_caching_state cstate)
365 {
366         enum pool_type type = IS_UNDEFINED;
367
368         if (flags & TTM_PAGE_FLAG_DMA32)
369                 type |= IS_DMA32;
370         if (cstate == tt_cached)
371                 type |= IS_CACHED;
372         else if (cstate == tt_uncached)
373                 type |= IS_UC;
374         else
375                 type |= IS_WC;
376
377         return type;
378 }
379
380 static void ttm_pool_update_free_locked(struct dma_pool *pool,
381                                         unsigned freed_pages)
382 {
383         pool->npages_free -= freed_pages;
384         pool->nfrees += freed_pages;
385
386 }
387
388 /* set memory back to wb and free the pages. */
389 static void ttm_dma_page_put(struct dma_pool *pool, struct dma_page *d_page)
390 {
391         struct page *page = d_page->p;
392         unsigned i, num_pages;
393
394         /* Don't set WB on WB page pool. */
395         if (!(pool->type & IS_CACHED)) {
396                 num_pages = pool->size / PAGE_SIZE;
397                 for (i = 0; i < num_pages; ++i, ++page) {
398                         if (set_pages_array_wb(&page, 1)) {
399                                 pr_err("%s: Failed to set %d pages to wb!\n",
400                                        pool->dev_name, 1);
401                         }
402                 }
403         }
404
405         list_del(&d_page->page_list);
406         __ttm_dma_free_page(pool, d_page);
407 }
408
409 static void ttm_dma_pages_put(struct dma_pool *pool, struct list_head *d_pages,
410                               struct page *pages[], unsigned npages)
411 {
412         struct dma_page *d_page, *tmp;
413
414         if (pool->type & IS_HUGE) {
415                 list_for_each_entry_safe(d_page, tmp, d_pages, page_list)
416                         ttm_dma_page_put(pool, d_page);
417
418                 return;
419         }
420
421         /* Don't set WB on WB page pool. */
422         if (npages && !(pool->type & IS_CACHED) &&
423             set_pages_array_wb(pages, npages))
424                 pr_err("%s: Failed to set %d pages to wb!\n",
425                        pool->dev_name, npages);
426
427         list_for_each_entry_safe(d_page, tmp, d_pages, page_list) {
428                 list_del(&d_page->page_list);
429                 __ttm_dma_free_page(pool, d_page);
430         }
431 }
432
433 /*
434  * Free pages from pool.
435  *
436  * To prevent hogging the ttm_swap process we only free NUM_PAGES_TO_ALLOC
437  * number of pages in one go.
438  *
439  * @pool: to free the pages from
440  * @nr_free: If set to true will free all pages in pool
441  * @use_static: Safe to use static buffer
442  **/
443 static unsigned ttm_dma_page_pool_free(struct dma_pool *pool, unsigned nr_free,
444                                        bool use_static)
445 {
446         static struct page *static_buf[NUM_PAGES_TO_ALLOC];
447         unsigned long irq_flags;
448         struct dma_page *dma_p, *tmp;
449         struct page **pages_to_free;
450         struct list_head d_pages;
451         unsigned freed_pages = 0,
452                  npages_to_free = nr_free;
453
454         if (NUM_PAGES_TO_ALLOC < nr_free)
455                 npages_to_free = NUM_PAGES_TO_ALLOC;
456 #if 0
457         if (nr_free > 1) {
458                 pr_debug("%s: (%s:%d) Attempting to free %d (%d) pages\n",
459                          pool->dev_name, pool->name, current->pid,
460                          npages_to_free, nr_free);
461         }
462 #endif
463         if (use_static)
464                 pages_to_free = static_buf;
465         else
466                 pages_to_free = kmalloc(npages_to_free * sizeof(struct page *),
467                                         GFP_KERNEL);
468
469         if (!pages_to_free) {
470                 pr_debug("%s: Failed to allocate memory for pool free operation\n",
471                        pool->dev_name);
472                 return 0;
473         }
474         INIT_LIST_HEAD(&d_pages);
475 restart:
476         spin_lock_irqsave(&pool->lock, irq_flags);
477
478         /* We picking the oldest ones off the list */
479         list_for_each_entry_safe_reverse(dma_p, tmp, &pool->free_list,
480                                          page_list) {
481                 if (freed_pages >= npages_to_free)
482                         break;
483
484                 /* Move the dma_page from one list to another. */
485                 list_move(&dma_p->page_list, &d_pages);
486
487                 pages_to_free[freed_pages++] = dma_p->p;
488                 /* We can only remove NUM_PAGES_TO_ALLOC at a time. */
489                 if (freed_pages >= NUM_PAGES_TO_ALLOC) {
490
491                         ttm_pool_update_free_locked(pool, freed_pages);
492                         /**
493                          * Because changing page caching is costly
494                          * we unlock the pool to prevent stalling.
495                          */
496                         spin_unlock_irqrestore(&pool->lock, irq_flags);
497
498                         ttm_dma_pages_put(pool, &d_pages, pages_to_free,
499                                           freed_pages);
500
501                         INIT_LIST_HEAD(&d_pages);
502
503                         if (likely(nr_free != FREE_ALL_PAGES))
504                                 nr_free -= freed_pages;
505
506                         if (NUM_PAGES_TO_ALLOC >= nr_free)
507                                 npages_to_free = nr_free;
508                         else
509                                 npages_to_free = NUM_PAGES_TO_ALLOC;
510
511                         freed_pages = 0;
512
513                         /* free all so restart the processing */
514                         if (nr_free)
515                                 goto restart;
516
517                         /* Not allowed to fall through or break because
518                          * following context is inside spinlock while we are
519                          * outside here.
520                          */
521                         goto out;
522
523                 }
524         }
525
526         /* remove range of pages from the pool */
527         if (freed_pages) {
528                 ttm_pool_update_free_locked(pool, freed_pages);
529                 nr_free -= freed_pages;
530         }
531
532         spin_unlock_irqrestore(&pool->lock, irq_flags);
533
534         if (freed_pages)
535                 ttm_dma_pages_put(pool, &d_pages, pages_to_free, freed_pages);
536 out:
537         if (pages_to_free != static_buf)
538                 kfree(pages_to_free);
539         return nr_free;
540 }
541
542 static void ttm_dma_free_pool(struct device *dev, enum pool_type type)
543 {
544         struct device_pools *p;
545         struct dma_pool *pool;
546
547         if (!dev)
548                 return;
549
550         mutex_lock(&_manager->lock);
551         list_for_each_entry_reverse(p, &_manager->pools, pools) {
552                 if (p->dev != dev)
553                         continue;
554                 pool = p->pool;
555                 if (pool->type != type)
556                         continue;
557
558                 list_del(&p->pools);
559                 kfree(p);
560                 _manager->npools--;
561                 break;
562         }
563         list_for_each_entry_reverse(pool, &dev->dma_pools, pools) {
564                 if (pool->type != type)
565                         continue;
566                 /* Takes a spinlock.. */
567                 /* OK to use static buffer since global mutex is held. */
568                 ttm_dma_page_pool_free(pool, FREE_ALL_PAGES, true);
569                 WARN_ON(((pool->npages_in_use + pool->npages_free) != 0));
570                 /* This code path is called after _all_ references to the
571                  * struct device has been dropped - so nobody should be
572                  * touching it. In case somebody is trying to _add_ we are
573                  * guarded by the mutex. */
574                 list_del(&pool->pools);
575                 kfree(pool);
576                 break;
577         }
578         mutex_unlock(&_manager->lock);
579 }
580
581 /*
582  * On free-ing of the 'struct device' this deconstructor is run.
583  * Albeit the pool might have already been freed earlier.
584  */
585 static void ttm_dma_pool_release(struct device *dev, void *res)
586 {
587         struct dma_pool *pool = *(struct dma_pool **)res;
588
589         if (pool)
590                 ttm_dma_free_pool(dev, pool->type);
591 }
592
593 static int ttm_dma_pool_match(struct device *dev, void *res, void *match_data)
594 {
595         return *(struct dma_pool **)res == match_data;
596 }
597
598 static struct dma_pool *ttm_dma_pool_init(struct device *dev, gfp_t flags,
599                                           enum pool_type type)
600 {
601         const char *n[] = {"wc", "uc", "cached", " dma32", "huge"};
602         enum pool_type t[] = {IS_WC, IS_UC, IS_CACHED, IS_DMA32, IS_HUGE};
603         struct device_pools *sec_pool = NULL;
604         struct dma_pool *pool = NULL, **ptr;
605         unsigned i;
606         int ret = -ENODEV;
607         char *p;
608
609         if (!dev)
610                 return NULL;
611
612         ptr = devres_alloc(ttm_dma_pool_release, sizeof(*ptr), GFP_KERNEL);
613         if (!ptr)
614                 return NULL;
615
616         ret = -ENOMEM;
617
618         pool = kmalloc_node(sizeof(struct dma_pool), GFP_KERNEL,
619                             dev_to_node(dev));
620         if (!pool)
621                 goto err_mem;
622
623         sec_pool = kmalloc_node(sizeof(struct device_pools), GFP_KERNEL,
624                                 dev_to_node(dev));
625         if (!sec_pool)
626                 goto err_mem;
627
628         INIT_LIST_HEAD(&sec_pool->pools);
629         sec_pool->dev = dev;
630         sec_pool->pool =  pool;
631
632         INIT_LIST_HEAD(&pool->free_list);
633         INIT_LIST_HEAD(&pool->pools);
634         spin_lock_init(&pool->lock);
635         pool->dev = dev;
636         pool->npages_free = pool->npages_in_use = 0;
637         pool->nfrees = 0;
638         pool->gfp_flags = flags;
639         if (type & IS_HUGE)
640 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
641                 pool->size = HPAGE_PMD_SIZE;
642 #else
643                 BUG();
644 #endif
645         else
646                 pool->size = PAGE_SIZE;
647         pool->type = type;
648         pool->nrefills = 0;
649         p = pool->name;
650         for (i = 0; i < ARRAY_SIZE(t); i++) {
651                 if (type & t[i]) {
652                         p += snprintf(p, sizeof(pool->name) - (p - pool->name),
653                                       "%s", n[i]);
654                 }
655         }
656         *p = 0;
657         /* We copy the name for pr_ calls b/c when dma_pool_destroy is called
658          * - the kobj->name has already been deallocated.*/
659         snprintf(pool->dev_name, sizeof(pool->dev_name), "%s %s",
660                  dev_driver_string(dev), dev_name(dev));
661         mutex_lock(&_manager->lock);
662         /* You can get the dma_pool from either the global: */
663         list_add(&sec_pool->pools, &_manager->pools);
664         _manager->npools++;
665         /* or from 'struct device': */
666         list_add(&pool->pools, &dev->dma_pools);
667         mutex_unlock(&_manager->lock);
668
669         *ptr = pool;
670         devres_add(dev, ptr);
671
672         return pool;
673 err_mem:
674         devres_free(ptr);
675         kfree(sec_pool);
676         kfree(pool);
677         return ERR_PTR(ret);
678 }
679
680 static struct dma_pool *ttm_dma_find_pool(struct device *dev,
681                                           enum pool_type type)
682 {
683         struct dma_pool *pool, *tmp;
684
685         if (type == IS_UNDEFINED)
686                 return NULL;
687
688         /* NB: We iterate on the 'struct dev' which has no spinlock, but
689          * it does have a kref which we have taken. The kref is taken during
690          * graphic driver loading - in the drm_pci_init it calls either
691          * pci_dev_get or pci_register_driver which both end up taking a kref
692          * on 'struct device'.
693          *
694          * On teardown, the graphic drivers end up quiescing the TTM (put_pages)
695          * and calls the dev_res deconstructors: ttm_dma_pool_release. The nice
696          * thing is at that point of time there are no pages associated with the
697          * driver so this function will not be called.
698          */
699         list_for_each_entry_safe(pool, tmp, &dev->dma_pools, pools)
700                 if (pool->type == type)
701                         return pool;
702         return NULL;
703 }
704
705 /*
706  * Free pages the pages that failed to change the caching state. If there
707  * are pages that have changed their caching state already put them to the
708  * pool.
709  */
710 static void ttm_dma_handle_caching_state_failure(struct dma_pool *pool,
711                                                  struct list_head *d_pages,
712                                                  struct page **failed_pages,
713                                                  unsigned cpages)
714 {
715         struct dma_page *d_page, *tmp;
716         struct page *p;
717         unsigned i = 0;
718
719         p = failed_pages[0];
720         if (!p)
721                 return;
722         /* Find the failed page. */
723         list_for_each_entry_safe(d_page, tmp, d_pages, page_list) {
724                 if (d_page->p != p)
725                         continue;
726                 /* .. and then progress over the full list. */
727                 list_del(&d_page->page_list);
728                 __ttm_dma_free_page(pool, d_page);
729                 if (++i < cpages)
730                         p = failed_pages[i];
731                 else
732                         break;
733         }
734
735 }
736
737 /*
738  * Allocate 'count' pages, and put 'need' number of them on the
739  * 'pages' and as well on the 'dma_address' starting at 'dma_offset' offset.
740  * The full list of pages should also be on 'd_pages'.
741  * We return zero for success, and negative numbers as errors.
742  */
743 static int ttm_dma_pool_alloc_new_pages(struct dma_pool *pool,
744                                         struct list_head *d_pages,
745                                         unsigned count)
746 {
747         struct page **caching_array;
748         struct dma_page *dma_p;
749         struct page *p;
750         int r = 0;
751         unsigned i, j, npages, cpages;
752         unsigned max_cpages = min(count,
753                         (unsigned)(PAGE_SIZE/sizeof(struct page *)));
754
755         /* allocate array for page caching change */
756         caching_array = kmalloc(max_cpages*sizeof(struct page *), GFP_KERNEL);
757
758         if (!caching_array) {
759                 pr_debug("%s: Unable to allocate table for new pages\n",
760                        pool->dev_name);
761                 return -ENOMEM;
762         }
763
764         if (count > 1)
765                 pr_debug("%s: (%s:%d) Getting %d pages\n",
766                          pool->dev_name, pool->name, current->pid, count);
767
768         for (i = 0, cpages = 0; i < count; ++i) {
769                 dma_p = __ttm_dma_alloc_page(pool);
770                 if (!dma_p) {
771                         pr_debug("%s: Unable to get page %u\n",
772                                  pool->dev_name, i);
773
774                         /* store already allocated pages in the pool after
775                          * setting the caching state */
776                         if (cpages) {
777                                 r = ttm_set_pages_caching(pool, caching_array,
778                                                           cpages);
779                                 if (r)
780                                         ttm_dma_handle_caching_state_failure(
781                                                 pool, d_pages, caching_array,
782                                                 cpages);
783                         }
784                         r = -ENOMEM;
785                         goto out;
786                 }
787                 p = dma_p->p;
788                 list_add(&dma_p->page_list, d_pages);
789
790 #ifdef CONFIG_HIGHMEM
791                 /* gfp flags of highmem page should never be dma32 so we
792                  * we should be fine in such case
793                  */
794                 if (PageHighMem(p))
795                         continue;
796 #endif
797
798                 npages = pool->size / PAGE_SIZE;
799                 for (j = 0; j < npages; ++j) {
800                         caching_array[cpages++] = p + j;
801                         if (cpages == max_cpages) {
802                                 /* Note: Cannot hold the spinlock */
803                                 r = ttm_set_pages_caching(pool, caching_array,
804                                                           cpages);
805                                 if (r) {
806                                         ttm_dma_handle_caching_state_failure(
807                                              pool, d_pages, caching_array,
808                                              cpages);
809                                         goto out;
810                                 }
811                                 cpages = 0;
812                         }
813                 }
814         }
815
816         if (cpages) {
817                 r = ttm_set_pages_caching(pool, caching_array, cpages);
818                 if (r)
819                         ttm_dma_handle_caching_state_failure(pool, d_pages,
820                                         caching_array, cpages);
821         }
822 out:
823         kfree(caching_array);
824         return r;
825 }
826
827 /*
828  * @return count of pages still required to fulfill the request.
829  */
830 static int ttm_dma_page_pool_fill_locked(struct dma_pool *pool,
831                                          unsigned long *irq_flags)
832 {
833         unsigned count = _manager->options.small;
834         int r = pool->npages_free;
835
836         if (count > pool->npages_free) {
837                 struct list_head d_pages;
838
839                 INIT_LIST_HEAD(&d_pages);
840
841                 spin_unlock_irqrestore(&pool->lock, *irq_flags);
842
843                 /* Returns how many more are neccessary to fulfill the
844                  * request. */
845                 r = ttm_dma_pool_alloc_new_pages(pool, &d_pages, count);
846
847                 spin_lock_irqsave(&pool->lock, *irq_flags);
848                 if (!r) {
849                         /* Add the fresh to the end.. */
850                         list_splice(&d_pages, &pool->free_list);
851                         ++pool->nrefills;
852                         pool->npages_free += count;
853                         r = count;
854                 } else {
855                         struct dma_page *d_page;
856                         unsigned cpages = 0;
857
858                         pr_debug("%s: Failed to fill %s pool (r:%d)!\n",
859                                  pool->dev_name, pool->name, r);
860
861                         list_for_each_entry(d_page, &d_pages, page_list) {
862                                 cpages++;
863                         }
864                         list_splice_tail(&d_pages, &pool->free_list);
865                         pool->npages_free += cpages;
866                         r = cpages;
867                 }
868         }
869         return r;
870 }
871
872 /*
873  * The populate list is actually a stack (not that is matters as TTM
874  * allocates one page at a time.
875  * return dma_page pointer if success, otherwise NULL.
876  */
877 static struct dma_page *ttm_dma_pool_get_pages(struct dma_pool *pool,
878                                   struct ttm_dma_tt *ttm_dma,
879                                   unsigned index)
880 {
881         struct dma_page *d_page = NULL;
882         struct ttm_tt *ttm = &ttm_dma->ttm;
883         unsigned long irq_flags;
884         int count;
885
886         spin_lock_irqsave(&pool->lock, irq_flags);
887         count = ttm_dma_page_pool_fill_locked(pool, &irq_flags);
888         if (count) {
889                 d_page = list_first_entry(&pool->free_list, struct dma_page, page_list);
890                 ttm->pages[index] = d_page->p;
891                 ttm_dma->dma_address[index] = d_page->dma;
892                 list_move_tail(&d_page->page_list, &ttm_dma->pages_list);
893                 pool->npages_in_use += 1;
894                 pool->npages_free -= 1;
895         }
896         spin_unlock_irqrestore(&pool->lock, irq_flags);
897         return d_page;
898 }
899
900 static gfp_t ttm_dma_pool_gfp_flags(struct ttm_dma_tt *ttm_dma, bool huge)
901 {
902         struct ttm_tt *ttm = &ttm_dma->ttm;
903         gfp_t gfp_flags;
904
905         if (ttm->page_flags & TTM_PAGE_FLAG_DMA32)
906                 gfp_flags = GFP_USER | GFP_DMA32;
907         else
908                 gfp_flags = GFP_HIGHUSER;
909         if (ttm->page_flags & TTM_PAGE_FLAG_ZERO_ALLOC)
910                 gfp_flags |= __GFP_ZERO;
911
912         if (huge) {
913                 gfp_flags |= GFP_TRANSHUGE;
914                 gfp_flags &= ~__GFP_MOVABLE;
915                 gfp_flags &= ~__GFP_COMP;
916         }
917
918         if (ttm->page_flags & TTM_PAGE_FLAG_NO_RETRY)
919                 gfp_flags |= __GFP_RETRY_MAYFAIL;
920
921         return gfp_flags;
922 }
923
924 /*
925  * On success pages list will hold count number of correctly
926  * cached pages. On failure will hold the negative return value (-ENOMEM, etc).
927  */
928 int ttm_dma_populate(struct ttm_dma_tt *ttm_dma, struct device *dev,
929                         struct ttm_operation_ctx *ctx)
930 {
931         struct ttm_tt *ttm = &ttm_dma->ttm;
932         struct ttm_mem_global *mem_glob = ttm->bdev->glob->mem_glob;
933         unsigned long num_pages = ttm->num_pages;
934         struct dma_pool *pool;
935         struct dma_page *d_page;
936         enum pool_type type;
937         unsigned i;
938         int ret;
939
940         if (ttm->state != tt_unpopulated)
941                 return 0;
942
943         if (ttm_check_under_lowerlimit(mem_glob, num_pages, ctx))
944                 return -ENOMEM;
945
946         INIT_LIST_HEAD(&ttm_dma->pages_list);
947         i = 0;
948
949         type = ttm_to_type(ttm->page_flags, ttm->caching_state);
950
951 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
952         if (ttm->page_flags & TTM_PAGE_FLAG_DMA32)
953                 goto skip_huge;
954
955         pool = ttm_dma_find_pool(dev, type | IS_HUGE);
956         if (!pool) {
957                 gfp_t gfp_flags = ttm_dma_pool_gfp_flags(ttm_dma, true);
958
959                 pool = ttm_dma_pool_init(dev, gfp_flags, type | IS_HUGE);
960                 if (IS_ERR_OR_NULL(pool))
961                         goto skip_huge;
962         }
963
964         while (num_pages >= HPAGE_PMD_NR) {
965                 unsigned j;
966
967                 d_page = ttm_dma_pool_get_pages(pool, ttm_dma, i);
968                 if (!d_page)
969                         break;
970
971                 ret = ttm_mem_global_alloc_page(mem_glob, ttm->pages[i],
972                                                 pool->size, ctx);
973                 if (unlikely(ret != 0)) {
974                         ttm_dma_unpopulate(ttm_dma, dev);
975                         return -ENOMEM;
976                 }
977
978                 d_page->vaddr |= VADDR_FLAG_UPDATED_COUNT;
979                 for (j = i + 1; j < (i + HPAGE_PMD_NR); ++j) {
980                         ttm->pages[j] = ttm->pages[j - 1] + 1;
981                         ttm_dma->dma_address[j] = ttm_dma->dma_address[j - 1] +
982                                 PAGE_SIZE;
983                 }
984
985                 i += HPAGE_PMD_NR;
986                 num_pages -= HPAGE_PMD_NR;
987         }
988
989 skip_huge:
990 #endif
991
992         pool = ttm_dma_find_pool(dev, type);
993         if (!pool) {
994                 gfp_t gfp_flags = ttm_dma_pool_gfp_flags(ttm_dma, false);
995
996                 pool = ttm_dma_pool_init(dev, gfp_flags, type);
997                 if (IS_ERR_OR_NULL(pool))
998                         return -ENOMEM;
999         }
1000
1001         while (num_pages) {
1002                 d_page = ttm_dma_pool_get_pages(pool, ttm_dma, i);
1003                 if (!d_page) {
1004                         ttm_dma_unpopulate(ttm_dma, dev);
1005                         return -ENOMEM;
1006                 }
1007
1008                 ret = ttm_mem_global_alloc_page(mem_glob, ttm->pages[i],
1009                                                 pool->size, ctx);
1010                 if (unlikely(ret != 0)) {
1011                         ttm_dma_unpopulate(ttm_dma, dev);
1012                         return -ENOMEM;
1013                 }
1014
1015                 d_page->vaddr |= VADDR_FLAG_UPDATED_COUNT;
1016                 ++i;
1017                 --num_pages;
1018         }
1019
1020         if (unlikely(ttm->page_flags & TTM_PAGE_FLAG_SWAPPED)) {
1021                 ret = ttm_tt_swapin(ttm);
1022                 if (unlikely(ret != 0)) {
1023                         ttm_dma_unpopulate(ttm_dma, dev);
1024                         return ret;
1025                 }
1026         }
1027
1028         ttm->state = tt_unbound;
1029         return 0;
1030 }
1031 EXPORT_SYMBOL_GPL(ttm_dma_populate);
1032
1033 /* Put all pages in pages list to correct pool to wait for reuse */
1034 void ttm_dma_unpopulate(struct ttm_dma_tt *ttm_dma, struct device *dev)
1035 {
1036         struct ttm_tt *ttm = &ttm_dma->ttm;
1037         struct ttm_mem_global *mem_glob = ttm->bdev->glob->mem_glob;
1038         struct dma_pool *pool;
1039         struct dma_page *d_page, *next;
1040         enum pool_type type;
1041         bool is_cached = false;
1042         unsigned count, i, npages = 0;
1043         unsigned long irq_flags;
1044
1045         type = ttm_to_type(ttm->page_flags, ttm->caching_state);
1046
1047 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
1048         pool = ttm_dma_find_pool(dev, type | IS_HUGE);
1049         if (pool) {
1050                 count = 0;
1051                 list_for_each_entry_safe(d_page, next, &ttm_dma->pages_list,
1052                                          page_list) {
1053                         if (!(d_page->vaddr & VADDR_FLAG_HUGE_POOL))
1054                                 continue;
1055
1056                         count++;
1057                         if (d_page->vaddr & VADDR_FLAG_UPDATED_COUNT) {
1058                                 ttm_mem_global_free_page(mem_glob, d_page->p,
1059                                                          pool->size);
1060                                 d_page->vaddr &= ~VADDR_FLAG_UPDATED_COUNT;
1061                         }
1062                         ttm_dma_page_put(pool, d_page);
1063                 }
1064
1065                 spin_lock_irqsave(&pool->lock, irq_flags);
1066                 pool->npages_in_use -= count;
1067                 pool->nfrees += count;
1068                 spin_unlock_irqrestore(&pool->lock, irq_flags);
1069         }
1070 #endif
1071
1072         pool = ttm_dma_find_pool(dev, type);
1073         if (!pool)
1074                 return;
1075
1076         is_cached = (ttm_dma_find_pool(pool->dev,
1077                      ttm_to_type(ttm->page_flags, tt_cached)) == pool);
1078
1079         /* make sure pages array match list and count number of pages */
1080         count = 0;
1081         list_for_each_entry_safe(d_page, next, &ttm_dma->pages_list,
1082                                  page_list) {
1083                 ttm->pages[count] = d_page->p;
1084                 count++;
1085
1086                 if (d_page->vaddr & VADDR_FLAG_UPDATED_COUNT) {
1087                         ttm_mem_global_free_page(mem_glob, d_page->p,
1088                                                  pool->size);
1089                         d_page->vaddr &= ~VADDR_FLAG_UPDATED_COUNT;
1090                 }
1091
1092                 if (is_cached)
1093                         ttm_dma_page_put(pool, d_page);
1094         }
1095
1096         spin_lock_irqsave(&pool->lock, irq_flags);
1097         pool->npages_in_use -= count;
1098         if (is_cached) {
1099                 pool->nfrees += count;
1100         } else {
1101                 pool->npages_free += count;
1102                 list_splice(&ttm_dma->pages_list, &pool->free_list);
1103                 /*
1104                  * Wait to have at at least NUM_PAGES_TO_ALLOC number of pages
1105                  * to free in order to minimize calls to set_memory_wb().
1106                  */
1107                 if (pool->npages_free >= (_manager->options.max_size +
1108                                           NUM_PAGES_TO_ALLOC))
1109                         npages = pool->npages_free - _manager->options.max_size;
1110         }
1111         spin_unlock_irqrestore(&pool->lock, irq_flags);
1112
1113         INIT_LIST_HEAD(&ttm_dma->pages_list);
1114         for (i = 0; i < ttm->num_pages; i++) {
1115                 ttm->pages[i] = NULL;
1116                 ttm_dma->dma_address[i] = 0;
1117         }
1118
1119         /* shrink pool if necessary (only on !is_cached pools)*/
1120         if (npages)
1121                 ttm_dma_page_pool_free(pool, npages, false);
1122         ttm->state = tt_unpopulated;
1123 }
1124 EXPORT_SYMBOL_GPL(ttm_dma_unpopulate);
1125
1126 /**
1127  * Callback for mm to request pool to reduce number of page held.
1128  *
1129  * XXX: (dchinner) Deadlock warning!
1130  *
1131  * I'm getting sadder as I hear more pathetical whimpers about needing per-pool
1132  * shrinkers
1133  */
1134 static unsigned long
1135 ttm_dma_pool_shrink_scan(struct shrinker *shrink, struct shrink_control *sc)
1136 {
1137         static unsigned start_pool;
1138         unsigned idx = 0;
1139         unsigned pool_offset;
1140         unsigned shrink_pages = sc->nr_to_scan;
1141         struct device_pools *p;
1142         unsigned long freed = 0;
1143
1144         if (list_empty(&_manager->pools))
1145                 return SHRINK_STOP;
1146
1147         if (!mutex_trylock(&_manager->lock))
1148                 return SHRINK_STOP;
1149         if (!_manager->npools)
1150                 goto out;
1151         pool_offset = ++start_pool % _manager->npools;
1152         list_for_each_entry(p, &_manager->pools, pools) {
1153                 unsigned nr_free;
1154
1155                 if (!p->dev)
1156                         continue;
1157                 if (shrink_pages == 0)
1158                         break;
1159                 /* Do it in round-robin fashion. */
1160                 if (++idx < pool_offset)
1161                         continue;
1162                 nr_free = shrink_pages;
1163                 /* OK to use static buffer since global mutex is held. */
1164                 shrink_pages = ttm_dma_page_pool_free(p->pool, nr_free, true);
1165                 freed += nr_free - shrink_pages;
1166
1167                 pr_debug("%s: (%s:%d) Asked to shrink %d, have %d more to go\n",
1168                          p->pool->dev_name, p->pool->name, current->pid,
1169                          nr_free, shrink_pages);
1170         }
1171 out:
1172         mutex_unlock(&_manager->lock);
1173         return freed;
1174 }
1175
1176 static unsigned long
1177 ttm_dma_pool_shrink_count(struct shrinker *shrink, struct shrink_control *sc)
1178 {
1179         struct device_pools *p;
1180         unsigned long count = 0;
1181
1182         if (!mutex_trylock(&_manager->lock))
1183                 return 0;
1184         list_for_each_entry(p, &_manager->pools, pools)
1185                 count += p->pool->npages_free;
1186         mutex_unlock(&_manager->lock);
1187         return count;
1188 }
1189
1190 static int ttm_dma_pool_mm_shrink_init(struct ttm_pool_manager *manager)
1191 {
1192         manager->mm_shrink.count_objects = ttm_dma_pool_shrink_count;
1193         manager->mm_shrink.scan_objects = &ttm_dma_pool_shrink_scan;
1194         manager->mm_shrink.seeks = 1;
1195         return register_shrinker(&manager->mm_shrink);
1196 }
1197
1198 static void ttm_dma_pool_mm_shrink_fini(struct ttm_pool_manager *manager)
1199 {
1200         unregister_shrinker(&manager->mm_shrink);
1201 }
1202
1203 int ttm_dma_page_alloc_init(struct ttm_mem_global *glob, unsigned max_pages)
1204 {
1205         int ret;
1206
1207         WARN_ON(_manager);
1208
1209         pr_info("Initializing DMA pool allocator\n");
1210
1211         _manager = kzalloc(sizeof(*_manager), GFP_KERNEL);
1212         if (!_manager)
1213                 return -ENOMEM;
1214
1215         mutex_init(&_manager->lock);
1216         INIT_LIST_HEAD(&_manager->pools);
1217
1218         _manager->options.max_size = max_pages;
1219         _manager->options.small = SMALL_ALLOCATION;
1220         _manager->options.alloc_size = NUM_PAGES_TO_ALLOC;
1221
1222         /* This takes care of auto-freeing the _manager */
1223         ret = kobject_init_and_add(&_manager->kobj, &ttm_pool_kobj_type,
1224                                    &glob->kobj, "dma_pool");
1225         if (unlikely(ret != 0))
1226                 goto error;
1227
1228         ret = ttm_dma_pool_mm_shrink_init(_manager);
1229         if (unlikely(ret != 0))
1230                 goto error;
1231         return 0;
1232
1233 error:
1234         kobject_put(&_manager->kobj);
1235         _manager = NULL;
1236         return ret;
1237 }
1238
1239 void ttm_dma_page_alloc_fini(void)
1240 {
1241         struct device_pools *p, *t;
1242
1243         pr_info("Finalizing DMA pool allocator\n");
1244         ttm_dma_pool_mm_shrink_fini(_manager);
1245
1246         list_for_each_entry_safe_reverse(p, t, &_manager->pools, pools) {
1247                 dev_dbg(p->dev, "(%s:%d) Freeing.\n", p->pool->name,
1248                         current->pid);
1249                 WARN_ON(devres_destroy(p->dev, ttm_dma_pool_release,
1250                         ttm_dma_pool_match, p->pool));
1251                 ttm_dma_free_pool(p->dev, p->pool->type);
1252         }
1253         kobject_put(&_manager->kobj);
1254         _manager = NULL;
1255 }
1256
1257 int ttm_dma_page_alloc_debugfs(struct seq_file *m, void *data)
1258 {
1259         struct device_pools *p;
1260         struct dma_pool *pool = NULL;
1261
1262         if (!_manager) {
1263                 seq_printf(m, "No pool allocator running.\n");
1264                 return 0;
1265         }
1266         seq_printf(m, "         pool      refills   pages freed    inuse available     name\n");
1267         mutex_lock(&_manager->lock);
1268         list_for_each_entry(p, &_manager->pools, pools) {
1269                 struct device *dev = p->dev;
1270                 if (!dev)
1271                         continue;
1272                 pool = p->pool;
1273                 seq_printf(m, "%13s %12ld %13ld %8d %8d %8s\n",
1274                                 pool->name, pool->nrefills,
1275                                 pool->nfrees, pool->npages_in_use,
1276                                 pool->npages_free,
1277                                 pool->dev_name);
1278         }
1279         mutex_unlock(&_manager->lock);
1280         return 0;
1281 }
1282 EXPORT_SYMBOL_GPL(ttm_dma_page_alloc_debugfs);
1283
1284 #endif