• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 
2 /**********************************************************
3  * Copyright 2008-2022 VMware, Inc.  All rights reserved.
4  *
5  * Permission is hereby granted, free of charge, to any person
6  * obtaining a copy of this software and associated documentation
7  * files (the "Software"), to deal in the Software without
8  * restriction, including without limitation the rights to use, copy,
9  * modify, merge, publish, distribute, sublicense, and/or sell copies
10  * of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
20  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23  * SOFTWARE.
24  *
25  **********************************************************/
26 
27 #ifndef SVGA_SCREEN_CACHE_H_
28 #define SVGA_SCREEN_CACHE_H_
29 
30 
31 #include "svga_types.h"
32 #include "svga_reg.h"
33 #include "svga3d_reg.h"
34 
35 #include "util/u_thread.h"
36 
37 #include "util/list.h"
38 
39 
40 /* Guess the storage size of cached surfaces and try and keep it under
41  * this amount:
42  */
43 #define SVGA_HOST_SURFACE_CACHE_BYTES (16 * 1024 * 1024)
44 
45 /* Maximum number of discrete surfaces in the cache:
46  */
47 #define SVGA_HOST_SURFACE_CACHE_SIZE 1024
48 
49 /* Number of hash buckets:
50  */
51 #define SVGA_HOST_SURFACE_CACHE_BUCKETS 256
52 
53 
54 struct svga_winsys_surface;
55 struct svga_screen;
56 struct svga_context;
57 
58 /**
59  * Same as svga_winsys_screen::surface_create.
60  */
61 struct svga_host_surface_cache_key
62 {
63    SVGA3dSurfaceAllFlags flags;
64    SVGA3dSurfaceFormat format;
65    SVGA3dSize size;
66    uint32_t numFaces:3;
67    uint32_t arraySize:16;
68    uint32_t numMipLevels:6;
69    uint32_t cachable:1;         /* False if this is a shared surface */
70    uint32_t sampleCount:5;
71    uint32_t scanout:1;
72    uint32_t coherent:1;
73    uint32_t persistent:1;
74 };
75 
76 
77 struct svga_host_surface_cache_entry
78 {
79    /**
80     * Head for the LRU list, svga_host_surface_cache::unused, and
81     * svga_host_surface_cache::empty
82     */
83    struct list_head head;
84 
85    /** Head for the bucket lists. */
86    struct list_head bucket_head;
87 
88    struct svga_host_surface_cache_key key;
89    struct svga_winsys_surface *handle;
90 
91    struct pipe_fence_handle *fence;
92 };
93 
94 
95 /**
96  * Cache of the host surfaces.
97  *
98  * A cache entry can be in the following stages:
99  * 1. empty (entry->handle = NULL)
100  * 2. holding a buffer in a validate list
101  * 3. holding a buffer in an invalidate list
102  * 4. holding a flushed buffer (not in any validate list) with an active fence
103  * 5. holding a flushed buffer with an expired fence
104  *
105  * An entry progresses from 1 -> 2 -> 3 -> 4 -> 5. When we need an entry to put a
106  * buffer into we preferentially take from 1, or from the least recently used
107  * buffer from 4/5.
108  */
109 struct svga_host_surface_cache
110 {
111    mtx_t mutex;
112 
113    /* Unused buffers are put in buckets to speed up lookups */
114    struct list_head bucket[SVGA_HOST_SURFACE_CACHE_BUCKETS];
115 
116    /* Entries with unused buffers, ordered from most to least recently used
117     * (3 and 4) */
118    struct list_head unused;
119 
120    /* Entries with buffers still in validate list (2) */
121    struct list_head validated;
122 
123    /* Entries with buffers still in invalidate list (3) */
124    struct list_head invalidated;
125 
126    /** Empty entries (1) */
127    struct list_head empty;
128 
129    /** The actual storage for the entries */
130    struct svga_host_surface_cache_entry entries[SVGA_HOST_SURFACE_CACHE_SIZE];
131 
132    /** Sum of sizes of all surfaces (in bytes) */
133    unsigned total_size;
134 };
135 
136 
137 void
138 svga_screen_cache_cleanup(struct svga_screen *svgascreen);
139 
140 void
141 svga_screen_cache_flush(struct svga_screen *svgascreen,
142                         struct svga_context *svga,
143                         struct pipe_fence_handle *fence);
144 
145 enum pipe_error
146 svga_screen_cache_init(struct svga_screen *svgascreen);
147 
148 
149 struct svga_winsys_surface *
150 svga_screen_surface_create(struct svga_screen *svgascreen,
151                            unsigned bind_flags, enum pipe_resource_usage usage,
152                            bool *invalidated,
153                            struct svga_host_surface_cache_key *key);
154 
155 void
156 svga_screen_surface_destroy(struct svga_screen *svgascreen,
157                             const struct svga_host_surface_cache_key *key,
158                             bool to_invalidate,
159                             struct svga_winsys_surface **handle);
160 
161 void
162 svga_screen_cache_dump(const struct svga_screen *svgascreen);
163 
164 unsigned
165 svga_surface_size(const struct svga_host_surface_cache_key *key);
166 
167 
168 #endif /* SVGA_SCREEN_CACHE_H_ */
169