1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /**************************************************************************
4 * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the
9 * "Software"), to deal in the Software without restriction, including
10 * without limitation the rights to use, copy, modify, merge, publish,
11 * distribute, sub license, and/or sell copies of the Software, and to
12 * permit persons to whom the Software is furnished to do so, subject to
13 * the following conditions:
15 * The above copyright notice and this permission notice (including the
16 * next paragraph) shall be included in all copies or substantial portions
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
22 * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
23 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
24 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
25 * USE OR OTHER DEALINGS IN THE SOFTWARE.
27 **************************************************************************/
29 #define pr_fmt(fmt) "[TTM] " fmt
31 #include <drm/ttm/ttm_memory.h>
32 #include <drm/ttm/ttm_module.h>
33 #include <drm/ttm/ttm_page_alloc.h>
34 #include <linux/spinlock.h>
35 #include <linux/sched.h>
36 #include <linux/wait.h>
38 #include <linux/module.h>
39 #include <linux/slab.h>
40 #include <linux/swap.h>
42 #define TTM_MEMORY_ALLOC_RETRIES 4
46 struct ttm_mem_global *glob;
55 static struct attribute ttm_mem_sys = {
56 .name = "zone_memory",
59 static struct attribute ttm_mem_emer = {
60 .name = "emergency_memory",
61 .mode = S_IRUGO | S_IWUSR
63 static struct attribute ttm_mem_max = {
64 .name = "available_memory",
65 .mode = S_IRUGO | S_IWUSR
67 static struct attribute ttm_mem_swap = {
69 .mode = S_IRUGO | S_IWUSR
71 static struct attribute ttm_mem_used = {
72 .name = "used_memory",
76 static void ttm_mem_zone_kobj_release(struct kobject *kobj)
78 struct ttm_mem_zone *zone =
79 container_of(kobj, struct ttm_mem_zone, kobj);
81 pr_info("Zone %7s: Used memory at exit: %llu kiB\n",
82 zone->name, (unsigned long long)zone->used_mem >> 10);
86 static ssize_t ttm_mem_zone_show(struct kobject *kobj,
87 struct attribute *attr,
90 struct ttm_mem_zone *zone =
91 container_of(kobj, struct ttm_mem_zone, kobj);
94 spin_lock(&zone->glob->lock);
95 if (attr == &ttm_mem_sys)
97 else if (attr == &ttm_mem_emer)
99 else if (attr == &ttm_mem_max)
101 else if (attr == &ttm_mem_swap)
102 val = zone->swap_limit;
103 else if (attr == &ttm_mem_used)
104 val = zone->used_mem;
105 spin_unlock(&zone->glob->lock);
107 return snprintf(buffer, PAGE_SIZE, "%llu\n",
108 (unsigned long long) val >> 10);
111 static void ttm_check_swapping(struct ttm_mem_global *glob);
113 static ssize_t ttm_mem_zone_store(struct kobject *kobj,
114 struct attribute *attr,
118 struct ttm_mem_zone *zone =
119 container_of(kobj, struct ttm_mem_zone, kobj);
124 chars = sscanf(buffer, "%lu", &val);
131 spin_lock(&zone->glob->lock);
132 if (val64 > zone->zone_mem)
133 val64 = zone->zone_mem;
134 if (attr == &ttm_mem_emer) {
135 zone->emer_mem = val64;
136 if (zone->max_mem > val64)
137 zone->max_mem = val64;
138 } else if (attr == &ttm_mem_max) {
139 zone->max_mem = val64;
140 if (zone->emer_mem < val64)
141 zone->emer_mem = val64;
142 } else if (attr == &ttm_mem_swap)
143 zone->swap_limit = val64;
144 spin_unlock(&zone->glob->lock);
146 ttm_check_swapping(zone->glob);
151 static struct attribute *ttm_mem_zone_attrs[] = {
160 static const struct sysfs_ops ttm_mem_zone_ops = {
161 .show = &ttm_mem_zone_show,
162 .store = &ttm_mem_zone_store
165 static struct kobj_type ttm_mem_zone_kobj_type = {
166 .release = &ttm_mem_zone_kobj_release,
167 .sysfs_ops = &ttm_mem_zone_ops,
168 .default_attrs = ttm_mem_zone_attrs,
171 static struct attribute ttm_mem_global_lower_mem_limit = {
172 .name = "lower_mem_limit",
173 .mode = S_IRUGO | S_IWUSR
176 static ssize_t ttm_mem_global_show(struct kobject *kobj,
177 struct attribute *attr,
180 struct ttm_mem_global *glob =
181 container_of(kobj, struct ttm_mem_global, kobj);
184 spin_lock(&glob->lock);
185 val = glob->lower_mem_limit;
186 spin_unlock(&glob->lock);
187 /* convert from number of pages to KB */
188 val <<= (PAGE_SHIFT - 10);
189 return snprintf(buffer, PAGE_SIZE, "%llu\n",
190 (unsigned long long) val);
193 static ssize_t ttm_mem_global_store(struct kobject *kobj,
194 struct attribute *attr,
201 struct ttm_mem_global *glob =
202 container_of(kobj, struct ttm_mem_global, kobj);
204 chars = sscanf(buffer, "%lu", &val);
209 /* convert from KB to number of pages */
210 val64 >>= (PAGE_SHIFT - 10);
212 spin_lock(&glob->lock);
213 glob->lower_mem_limit = val64;
214 spin_unlock(&glob->lock);
219 static void ttm_mem_global_kobj_release(struct kobject *kobj)
221 struct ttm_mem_global *glob =
222 container_of(kobj, struct ttm_mem_global, kobj);
227 static struct attribute *ttm_mem_global_attrs[] = {
228 &ttm_mem_global_lower_mem_limit,
232 static const struct sysfs_ops ttm_mem_global_ops = {
233 .show = &ttm_mem_global_show,
234 .store = &ttm_mem_global_store,
237 static struct kobj_type ttm_mem_glob_kobj_type = {
238 .release = &ttm_mem_global_kobj_release,
239 .sysfs_ops = &ttm_mem_global_ops,
240 .default_attrs = ttm_mem_global_attrs,
243 static bool ttm_zones_above_swap_target(struct ttm_mem_global *glob,
244 bool from_wq, uint64_t extra)
247 struct ttm_mem_zone *zone;
250 for (i = 0; i < glob->num_zones; ++i) {
251 zone = glob->zones[i];
254 target = zone->swap_limit;
255 else if (capable(CAP_SYS_ADMIN))
256 target = zone->emer_mem;
258 target = zone->max_mem;
260 target = (extra > target) ? 0ULL : target;
262 if (zone->used_mem > target)
269 * At this point we only support a single shrink callback.
270 * Extend this if needed, perhaps using a linked list of callbacks.
271 * Note that this function is reentrant:
272 * many threads may try to swap out at any given time.
275 static void ttm_shrink(struct ttm_mem_global *glob, bool from_wq,
276 uint64_t extra, struct ttm_operation_ctx *ctx)
280 spin_lock(&glob->lock);
282 while (ttm_zones_above_swap_target(glob, from_wq, extra)) {
283 spin_unlock(&glob->lock);
284 ret = ttm_bo_swapout(glob->bo_glob, ctx);
285 spin_lock(&glob->lock);
286 if (unlikely(ret != 0))
290 spin_unlock(&glob->lock);
293 static void ttm_shrink_work(struct work_struct *work)
295 struct ttm_operation_ctx ctx = {
296 .interruptible = false,
299 struct ttm_mem_global *glob =
300 container_of(work, struct ttm_mem_global, work);
302 ttm_shrink(glob, true, 0ULL, &ctx);
305 static int ttm_mem_init_kernel_zone(struct ttm_mem_global *glob,
306 const struct sysinfo *si)
308 struct ttm_mem_zone *zone = kzalloc(sizeof(*zone), GFP_KERNEL);
315 mem = si->totalram - si->totalhigh;
318 zone->name = "kernel";
319 zone->zone_mem = mem;
320 zone->max_mem = mem >> 1;
321 zone->emer_mem = (mem >> 1) + (mem >> 2);
322 zone->swap_limit = zone->max_mem - (mem >> 3);
325 glob->zone_kernel = zone;
326 ret = kobject_init_and_add(
327 &zone->kobj, &ttm_mem_zone_kobj_type, &glob->kobj, zone->name);
328 if (unlikely(ret != 0)) {
329 kobject_put(&zone->kobj);
332 glob->zones[glob->num_zones++] = zone;
336 #ifdef CONFIG_HIGHMEM
337 static int ttm_mem_init_highmem_zone(struct ttm_mem_global *glob,
338 const struct sysinfo *si)
340 struct ttm_mem_zone *zone;
344 if (si->totalhigh == 0)
347 zone = kzalloc(sizeof(*zone), GFP_KERNEL);
354 zone->name = "highmem";
355 zone->zone_mem = mem;
356 zone->max_mem = mem >> 1;
357 zone->emer_mem = (mem >> 1) + (mem >> 2);
358 zone->swap_limit = zone->max_mem - (mem >> 3);
361 glob->zone_highmem = zone;
362 ret = kobject_init_and_add(
363 &zone->kobj, &ttm_mem_zone_kobj_type, &glob->kobj, "%s",
365 if (unlikely(ret != 0)) {
366 kobject_put(&zone->kobj);
369 glob->zones[glob->num_zones++] = zone;
373 static int ttm_mem_init_dma32_zone(struct ttm_mem_global *glob,
374 const struct sysinfo *si)
376 struct ttm_mem_zone *zone = kzalloc(sizeof(*zone), GFP_KERNEL);
387 * No special dma32 zone needed.
390 if (mem <= ((uint64_t) 1ULL << 32)) {
396 * Limit max dma32 memory to 4GB for now
397 * until we can figure out how big this
401 mem = ((uint64_t) 1ULL << 32);
402 zone->name = "dma32";
403 zone->zone_mem = mem;
404 zone->max_mem = mem >> 1;
405 zone->emer_mem = (mem >> 1) + (mem >> 2);
406 zone->swap_limit = zone->max_mem - (mem >> 3);
409 glob->zone_dma32 = zone;
410 ret = kobject_init_and_add(
411 &zone->kobj, &ttm_mem_zone_kobj_type, &glob->kobj, zone->name);
412 if (unlikely(ret != 0)) {
413 kobject_put(&zone->kobj);
416 glob->zones[glob->num_zones++] = zone;
421 int ttm_mem_global_init(struct ttm_mem_global *glob)
426 struct ttm_mem_zone *zone;
428 spin_lock_init(&glob->lock);
429 glob->swap_queue = create_singlethread_workqueue("ttm_swap");
430 INIT_WORK(&glob->work, ttm_shrink_work);
431 ret = kobject_init_and_add(
432 &glob->kobj, &ttm_mem_glob_kobj_type, ttm_get_kobj(), "memory_accounting");
433 if (unlikely(ret != 0)) {
434 kobject_put(&glob->kobj);
440 /* set it as 0 by default to keep original behavior of OOM */
441 glob->lower_mem_limit = 0;
443 ret = ttm_mem_init_kernel_zone(glob, &si);
444 if (unlikely(ret != 0))
446 #ifdef CONFIG_HIGHMEM
447 ret = ttm_mem_init_highmem_zone(glob, &si);
448 if (unlikely(ret != 0))
451 ret = ttm_mem_init_dma32_zone(glob, &si);
452 if (unlikely(ret != 0))
455 for (i = 0; i < glob->num_zones; ++i) {
456 zone = glob->zones[i];
457 pr_info("Zone %7s: Available graphics memory: %llu kiB\n",
458 zone->name, (unsigned long long)zone->max_mem >> 10);
460 ttm_page_alloc_init(glob, glob->zone_kernel->max_mem/(2*PAGE_SIZE));
461 ttm_dma_page_alloc_init(glob, glob->zone_kernel->max_mem/(2*PAGE_SIZE));
464 ttm_mem_global_release(glob);
467 EXPORT_SYMBOL(ttm_mem_global_init);
469 void ttm_mem_global_release(struct ttm_mem_global *glob)
472 struct ttm_mem_zone *zone;
474 /* let the page allocator first stop the shrink work. */
475 ttm_page_alloc_fini();
476 ttm_dma_page_alloc_fini();
478 flush_workqueue(glob->swap_queue);
479 destroy_workqueue(glob->swap_queue);
480 glob->swap_queue = NULL;
481 for (i = 0; i < glob->num_zones; ++i) {
482 zone = glob->zones[i];
483 kobject_del(&zone->kobj);
484 kobject_put(&zone->kobj);
486 kobject_del(&glob->kobj);
487 kobject_put(&glob->kobj);
489 EXPORT_SYMBOL(ttm_mem_global_release);
491 static void ttm_check_swapping(struct ttm_mem_global *glob)
493 bool needs_swapping = false;
495 struct ttm_mem_zone *zone;
497 spin_lock(&glob->lock);
498 for (i = 0; i < glob->num_zones; ++i) {
499 zone = glob->zones[i];
500 if (zone->used_mem > zone->swap_limit) {
501 needs_swapping = true;
506 spin_unlock(&glob->lock);
508 if (unlikely(needs_swapping))
509 (void)queue_work(glob->swap_queue, &glob->work);
513 static void ttm_mem_global_free_zone(struct ttm_mem_global *glob,
514 struct ttm_mem_zone *single_zone,
518 struct ttm_mem_zone *zone;
520 spin_lock(&glob->lock);
521 for (i = 0; i < glob->num_zones; ++i) {
522 zone = glob->zones[i];
523 if (single_zone && zone != single_zone)
525 zone->used_mem -= amount;
527 spin_unlock(&glob->lock);
530 void ttm_mem_global_free(struct ttm_mem_global *glob,
533 return ttm_mem_global_free_zone(glob, NULL, amount);
535 EXPORT_SYMBOL(ttm_mem_global_free);
538 * check if the available mem is under lower memory limit
540 * a. if no swap disk at all or free swap space is under swap_mem_limit
541 * but available system mem is bigger than sys_mem_limit, allow TTM
544 * b. if the available system mem is less than sys_mem_limit but free
545 * swap disk is bigger than swap_mem_limit, allow TTM allocation.
548 ttm_check_under_lowerlimit(struct ttm_mem_global *glob,
550 struct ttm_operation_ctx *ctx)
554 if (ctx->flags & TTM_OPT_FLAG_FORCE_ALLOC)
557 available = get_nr_swap_pages() + si_mem_available();
558 available -= num_pages;
559 if (available < glob->lower_mem_limit)
564 EXPORT_SYMBOL(ttm_check_under_lowerlimit);
566 static int ttm_mem_global_reserve(struct ttm_mem_global *glob,
567 struct ttm_mem_zone *single_zone,
568 uint64_t amount, bool reserve)
573 struct ttm_mem_zone *zone;
575 spin_lock(&glob->lock);
576 for (i = 0; i < glob->num_zones; ++i) {
577 zone = glob->zones[i];
578 if (single_zone && zone != single_zone)
581 limit = (capable(CAP_SYS_ADMIN)) ?
582 zone->emer_mem : zone->max_mem;
584 if (zone->used_mem > limit)
589 for (i = 0; i < glob->num_zones; ++i) {
590 zone = glob->zones[i];
591 if (single_zone && zone != single_zone)
593 zone->used_mem += amount;
599 spin_unlock(&glob->lock);
600 ttm_check_swapping(glob);
606 static int ttm_mem_global_alloc_zone(struct ttm_mem_global *glob,
607 struct ttm_mem_zone *single_zone,
609 struct ttm_operation_ctx *ctx)
611 int count = TTM_MEMORY_ALLOC_RETRIES;
613 while (unlikely(ttm_mem_global_reserve(glob,
617 if (ctx->no_wait_gpu)
619 if (unlikely(count-- == 0))
621 ttm_shrink(glob, false, memory + (memory >> 2) + 16, ctx);
627 int ttm_mem_global_alloc(struct ttm_mem_global *glob, uint64_t memory,
628 struct ttm_operation_ctx *ctx)
631 * Normal allocations of kernel memory are registered in
635 return ttm_mem_global_alloc_zone(glob, NULL, memory, ctx);
637 EXPORT_SYMBOL(ttm_mem_global_alloc);
639 int ttm_mem_global_alloc_page(struct ttm_mem_global *glob,
640 struct page *page, uint64_t size,
641 struct ttm_operation_ctx *ctx)
643 struct ttm_mem_zone *zone = NULL;
646 * Page allocations may be registed in a single zone
647 * only if highmem or !dma32.
650 #ifdef CONFIG_HIGHMEM
651 if (PageHighMem(page) && glob->zone_highmem != NULL)
652 zone = glob->zone_highmem;
654 if (glob->zone_dma32 && page_to_pfn(page) > 0x00100000UL)
655 zone = glob->zone_kernel;
657 return ttm_mem_global_alloc_zone(glob, zone, size, ctx);
660 void ttm_mem_global_free_page(struct ttm_mem_global *glob, struct page *page,
663 struct ttm_mem_zone *zone = NULL;
665 #ifdef CONFIG_HIGHMEM
666 if (PageHighMem(page) && glob->zone_highmem != NULL)
667 zone = glob->zone_highmem;
669 if (glob->zone_dma32 && page_to_pfn(page) > 0x00100000UL)
670 zone = glob->zone_kernel;
672 ttm_mem_global_free_zone(glob, zone, size);
675 size_t ttm_round_pot(size_t size)
677 if ((size & (size - 1)) == 0)
679 else if (size > PAGE_SIZE)
680 return PAGE_ALIGN(size);
684 while (tmp_size < size)
691 EXPORT_SYMBOL(ttm_round_pot);
693 uint64_t ttm_get_kernel_zone_memory_size(struct ttm_mem_global *glob)
695 return glob->zone_kernel->max_mem;
697 EXPORT_SYMBOL(ttm_get_kernel_zone_memory_size);