1/* SPDX-License-Identifier: GPL-2.0 OR MIT */
  2/**************************************************************************
  3 *
  4 * Copyright (c) 2007-2010 VMware, Inc., Palo Alto, CA., USA
  5 * All Rights Reserved.
  6 *
  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:
 14 *
 15 * The above copyright notice and this permission notice (including the
 16 * next paragraph) shall be included in all copies or substantial portions
 17 * of the Software.
 18 *
 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.
 26 *
 27 **************************************************************************/
 28/*
 29 * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
 30 */
 31
 32#include <drm/ttm/ttm_device.h>
 33#include <drm/ttm/ttm_placement.h>
 34#include <drm/ttm/ttm_range_manager.h>
 35#include <drm/ttm/ttm_bo_api.h>
 36#include <drm/drm_mm.h>
 37#include <linux/slab.h>
 38#include <linux/spinlock.h>
 39
 40/*
 41 * Currently we use a spinlock for the lock, but a mutex *may* be
 42 * more appropriate to reduce scheduling latency if the range manager
 43 * ends up with very fragmented allocation patterns.
 44 */
 45
 46struct ttm_range_manager {
 47	struct ttm_resource_manager manager;
 48	struct drm_mm mm;
 49	spinlock_t lock;
 50};
 51
 52static inline struct ttm_range_manager *
 53to_range_manager(struct ttm_resource_manager *man)
 54{
 55	return container_of(man, struct ttm_range_manager, manager);
 56}
 57
 58static int ttm_range_man_alloc(struct ttm_resource_manager *man,
 59			       struct ttm_buffer_object *bo,
 60			       const struct ttm_place *place,
 61			       struct ttm_resource **res)
 62{
 63	struct ttm_range_manager *rman = to_range_manager(man);
 64	struct ttm_range_mgr_node *node;
 65	struct drm_mm *mm = &rman->mm;
 66	enum drm_mm_insert_mode mode;
 67	unsigned long lpfn;
 68	int ret;
 69
 70	lpfn = place->lpfn;
 71	if (!lpfn)
 72		lpfn = man->size;
 73
 74	node = kzalloc(struct_size(node, mm_nodes, 1), GFP_KERNEL);
 75	if (!node)
 76		return -ENOMEM;
 77
 78	mode = DRM_MM_INSERT_BEST;
 79	if (place->flags & TTM_PL_FLAG_TOPDOWN)
 80		mode = DRM_MM_INSERT_HIGH;
 81
 82	ttm_resource_init(bo, place, &node->base);
 83
 84	spin_lock(&rman->lock);
 85	ret = drm_mm_insert_node_in_range(mm, &node->mm_nodes[0],
 86					  node->base.num_pages,
 87					  bo->page_alignment, 0,
 88					  place->fpfn, lpfn, mode);
 89	spin_unlock(&rman->lock);
 90
 91	if (unlikely(ret)) {
 92		kfree(node);
 93		return ret;
 94	}
 95
 96	node->base.start = node->mm_nodes[0].start;
 97	*res = &node->base;
 98	return 0;
 99}
100
101static void ttm_range_man_free(struct ttm_resource_manager *man,
102			       struct ttm_resource *res)
103{
104	struct ttm_range_mgr_node *node = to_ttm_range_mgr_node(res);
105	struct ttm_range_manager *rman = to_range_manager(man);
106
107	spin_lock(&rman->lock);
108	drm_mm_remove_node(&node->mm_nodes[0]);
109	spin_unlock(&rman->lock);
110
111	kfree(node);
112}
113
114static void ttm_range_man_debug(struct ttm_resource_manager *man,
115				struct drm_printer *printer)
116{
117	struct ttm_range_manager *rman = to_range_manager(man);
118
119	spin_lock(&rman->lock);
120	drm_mm_print(&rman->mm, printer);
121	spin_unlock(&rman->lock);
122}
123
124static const struct ttm_resource_manager_func ttm_range_manager_func = {
125	.alloc = ttm_range_man_alloc,
126	.free = ttm_range_man_free,
127	.debug = ttm_range_man_debug
128};
129
130/**
131 * ttm_range_man_init
132 *
133 * @bdev: ttm device
134 * @type: memory manager type
135 * @use_tt: if the memory manager uses tt
136 * @p_size: size of area to be managed in pages.
137 *
138 * Initialise a generic range manager for the selected memory type.
139 * The range manager is installed for this device in the type slot.
140 */
141int ttm_range_man_init(struct ttm_device *bdev,
142		       unsigned type, bool use_tt,
143		       unsigned long p_size)
144{
145	struct ttm_resource_manager *man;
146	struct ttm_range_manager *rman;
147
148	rman = kzalloc(sizeof(*rman), GFP_KERNEL);
149	if (!rman)
150		return -ENOMEM;
151
152	man = &rman->manager;
153	man->use_tt = use_tt;
154
155	man->func = &ttm_range_manager_func;
156
157	ttm_resource_manager_init(man, p_size);
158
159	drm_mm_init(&rman->mm, 0, p_size);
160	spin_lock_init(&rman->lock);
161
162	ttm_set_driver_manager(bdev, type, &rman->manager);
163	ttm_resource_manager_set_used(man, true);
164	return 0;
165}
166EXPORT_SYMBOL(ttm_range_man_init);
167
168/**
169 * ttm_range_man_fini
170 *
171 * @bdev: ttm device
172 * @type: memory manager type
173 *
174 * Remove the generic range manager from a slot and tear it down.
175 */
176int ttm_range_man_fini(struct ttm_device *bdev,
177		       unsigned type)
178{
179	struct ttm_resource_manager *man = ttm_manager_type(bdev, type);
180	struct ttm_range_manager *rman = to_range_manager(man);
181	struct drm_mm *mm = &rman->mm;
182	int ret;
183
184	if (!man)
185		return 0;
186
187	ttm_resource_manager_set_used(man, false);
188
189	ret = ttm_resource_manager_evict_all(bdev, man);
190	if (ret)
191		return ret;
192
193	spin_lock(&rman->lock);
194	drm_mm_clean(mm);
195	drm_mm_takedown(mm);
196	spin_unlock(&rman->lock);
197
198	ttm_resource_manager_cleanup(man);
199	ttm_set_driver_manager(bdev, type, NULL);
200	kfree(rman);
201	return 0;
202}
203EXPORT_SYMBOL(ttm_range_man_fini);