panfrost: Add a sparse array to map GEM handles to BOs
[mesa.git] / src / panfrost / encoder / pan_device.h
1 /**************************************************************************
2 *
3 * Copyright 2018-2019 Alyssa Rosenzweig
4 * Copyright 2018-2019 Collabora, Ltd.
5 * Copyright © 2015 Intel Corporation
6 * All Rights Reserved.
7 *
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sub license, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
15 *
16 * The above copyright notice and this permission notice (including the
17 * next paragraph) shall be included in all copies or substantial portions
18 * of the Software.
19 *
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
23 * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
24 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 *
28 **************************************************************************/
29
30 #ifndef PAN_DEVICE_H
31 #define PAN_DEVICE_H
32
33 #include <xf86drm.h>
34 #include "renderonly/renderonly.h"
35 #include "util/u_dynarray.h"
36 #include "util/bitset.h"
37 #include "util/set.h"
38 #include "util/list.h"
39 #include "util/sparse_array.h"
40
41 #include <panfrost-misc.h>
42
43 /* Driver limits */
44 #define PAN_MAX_CONST_BUFFERS 16
45
46 /* Transient slab size. This is a balance between fragmentation against cache
47 * locality and ease of bookkeeping */
48
49 #define TRANSIENT_SLAB_PAGES (32) /* 128kb */
50 #define TRANSIENT_SLAB_SIZE (4096 * TRANSIENT_SLAB_PAGES)
51
52 /* Maximum number of transient slabs so we don't need dynamic arrays. Most
53 * interesting Mali boards are 4GB RAM max, so if the entire RAM was filled
54 * with transient slabs, you could never exceed (4GB / TRANSIENT_SLAB_SIZE)
55 * allocations anyway. By capping, we can use a fixed-size bitset for tracking
56 * free slabs, eliminating quite a bit of complexity. We can pack the free
57 * state of 8 slabs into a single byte, so for 128kb transient slabs the bitset
58 * occupies a cheap 4kb of memory */
59
60 #define MAX_TRANSIENT_SLABS (1024*1024 / TRANSIENT_SLAB_PAGES)
61
62 /* How many power-of-two levels in the BO cache do we want? 2^12
63 * minimum chosen as it is the page size that all allocations are
64 * rounded to */
65
66 #define MIN_BO_CACHE_BUCKET (12) /* 2^12 = 4KB */
67 #define MAX_BO_CACHE_BUCKET (22) /* 2^22 = 4MB */
68
69 /* Fencepost problem, hence the off-by-one */
70 #define NR_BO_CACHE_BUCKETS (MAX_BO_CACHE_BUCKET - MIN_BO_CACHE_BUCKET + 1)
71
72 struct panfrost_device {
73 /* For ralloc */
74 void *memctx;
75
76 int fd;
77
78 /* Properties of the GPU in use */
79 unsigned gpu_id;
80 unsigned core_count;
81 unsigned thread_tls_alloc;
82 unsigned quirks;
83
84 /* debug flags, see pan_util.h how to interpret */
85 unsigned debug;
86
87 drmVersionPtr kernel_version;
88
89 struct renderonly *ro;
90
91 pthread_mutex_t active_bos_lock;
92 struct set *active_bos;
93
94 pthread_mutex_t bo_map_lock;
95 struct util_sparse_array bo_map;
96
97 struct {
98 pthread_mutex_t lock;
99
100 /* List containing all cached BOs sorted in LRU (Least
101 * Recently Used) order. This allows us to quickly evict BOs
102 * that are more than 1 second old.
103 */
104 struct list_head lru;
105
106 /* The BO cache is a set of buckets with power-of-two sizes
107 * ranging from 2^12 (4096, the page size) to
108 * 2^(12 + MAX_BO_CACHE_BUCKETS).
109 * Each bucket is a linked list of free panfrost_bo objects. */
110
111 struct list_head buckets[NR_BO_CACHE_BUCKETS];
112 } bo_cache;
113 };
114
115 void
116 panfrost_open_device(void *memctx, int fd, struct panfrost_device *dev);
117
118 void
119 panfrost_close_device(struct panfrost_device *dev);
120
121 static inline struct panfrost_bo *
122 pan_lookup_bo(struct panfrost_device *dev, uint32_t gem_handle)
123 {
124 return util_sparse_array_get(&dev->bo_map, gem_handle);
125 }
126
127 #endif