xref: /linux/include/drm/ttm/ttm_pool.h (revision aec2f682d47c54ef434b2d440992626d80b1ebdc)
1 /* SPDX-License-Identifier: GPL-2.0 OR MIT */
2 /*
3  * Copyright 2020 Advanced Micro Devices, Inc.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions 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 NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
19  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
20  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
21  * OTHER DEALINGS IN THE SOFTWARE.
22  *
23  * Authors: Christian König
24  */
25 
26 #ifndef _TTM_PAGE_POOL_H_
27 #define _TTM_PAGE_POOL_H_
28 
29 #include <linux/mmzone.h>
30 #include <linux/llist.h>
31 #include <linux/spinlock.h>
32 #include <linux/list_lru.h>
33 #include <drm/ttm/ttm_caching.h>
34 
35 struct device;
36 struct seq_file;
37 struct ttm_backup_flags;
38 struct ttm_operation_ctx;
39 struct ttm_pool;
40 struct ttm_tt;
41 
42 /**
43  * struct ttm_pool_type - Pool for a certain memory type
44  *
45  * @pool: the pool we belong to, might be NULL for the global ones
46  * @order: the allocation order our pages have
47  * @caching: the caching type our pages have
48  * @shrinker_list: our place on the global shrinker list
49  * @pages: the lru_list of pages in the pool
50  */
51 struct ttm_pool_type {
52 	struct ttm_pool *pool;
53 	unsigned int order;
54 	enum ttm_caching caching;
55 
56 	struct list_head shrinker_list;
57 
58 	struct list_lru pages;
59 };
60 
61 /**
62  * struct ttm_pool - Pool for all caching and orders
63  *
64  * @dev: the device we allocate pages for
65  * @nid: which numa node to use
66  * @alloc_flags: TTM_ALLOCATION_POOL_* flags
67  * @caching: pools for each caching/order
68  */
69 struct ttm_pool {
70 	struct device *dev;
71 	int nid;
72 
73 	unsigned int alloc_flags;
74 
75 	struct {
76 		struct ttm_pool_type orders[NR_PAGE_ORDERS];
77 	} caching[TTM_NUM_CACHING_TYPES];
78 };
79 
80 int ttm_pool_alloc(struct ttm_pool *pool, struct ttm_tt *tt,
81 		   struct ttm_operation_ctx *ctx);
82 void ttm_pool_free(struct ttm_pool *pool, struct ttm_tt *tt);
83 
84 void ttm_pool_init(struct ttm_pool *pool, struct device *dev,
85 		   int nid, unsigned int alloc_flags);
86 void ttm_pool_fini(struct ttm_pool *pool);
87 
88 int ttm_pool_debugfs(struct ttm_pool *pool, struct seq_file *m);
89 
90 void ttm_pool_drop_backed_up(struct ttm_tt *tt);
91 
92 long ttm_pool_backup(struct ttm_pool *pool, struct ttm_tt *ttm,
93 		     const struct ttm_backup_flags *flags);
94 int ttm_pool_restore_and_alloc(struct ttm_pool *pool, struct ttm_tt *tt,
95 			       const struct ttm_operation_ctx *ctx);
96 
97 int ttm_pool_mgr_init(unsigned long num_pages);
98 void ttm_pool_mgr_fini(void);
99 
100 #endif
101