1
2/**********************************************************
3 * Copyright 2008-2009 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 "os/os_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
54struct svga_winsys_surface;
55struct svga_screen;
56struct svga_context;
57
58/**
59 * Same as svga_winsys_screen::surface_create.
60 */
61struct 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};
74
75
76struct svga_host_surface_cache_entry
77{
78   /**
79    * Head for the LRU list, svga_host_surface_cache::unused, and
80    * svga_host_surface_cache::empty
81    */
82   struct list_head head;
83
84   /** Head for the bucket lists. */
85   struct list_head bucket_head;
86
87   struct svga_host_surface_cache_key key;
88   struct svga_winsys_surface *handle;
89
90   struct pipe_fence_handle *fence;
91};
92
93
94/**
95 * Cache of the host surfaces.
96 *
97 * A cache entry can be in the following stages:
98 * 1. empty (entry->handle = NULL)
99 * 2. holding a buffer in a validate list
100 * 3. holding a buffer in an invalidate list
101 * 4. holding a flushed buffer (not in any validate list) with an active fence
102 * 5. holding a flushed buffer with an expired fence
103 *
104 * An entry progresses from 1 -> 2 -> 3 -> 4 -> 5. When we need an entry to put a
105 * buffer into we preferentially take from 1, or from the least recently used
106 * buffer from 4/5.
107 */
108struct svga_host_surface_cache
109{
110   mtx_t mutex;
111
112   /* Unused buffers are put in buckets to speed up lookups */
113   struct list_head bucket[SVGA_HOST_SURFACE_CACHE_BUCKETS];
114
115   /* Entries with unused buffers, ordered from most to least recently used
116    * (3 and 4) */
117   struct list_head unused;
118
119   /* Entries with buffers still in validate list (2) */
120   struct list_head validated;
121
122   /* Entries with buffers still in invalidate list (3) */
123   struct list_head invalidated;
124
125   /** Empty entries (1) */
126   struct list_head empty;
127
128   /** The actual storage for the entries */
129   struct svga_host_surface_cache_entry entries[SVGA_HOST_SURFACE_CACHE_SIZE];
130
131   /** Sum of sizes of all surfaces (in bytes) */
132   unsigned total_size;
133};
134
135
136void
137svga_screen_cache_cleanup(struct svga_screen *svgascreen);
138
139void
140svga_screen_cache_flush(struct svga_screen *svgascreen,
141                        struct svga_context *svga,
142                        struct pipe_fence_handle *fence);
143
144enum pipe_error
145svga_screen_cache_init(struct svga_screen *svgascreen);
146
147
148struct svga_winsys_surface *
149svga_screen_surface_create(struct svga_screen *svgascreen,
150                           unsigned bind_flags, enum pipe_resource_usage usage,
151                           boolean *invalidated,
152                           struct svga_host_surface_cache_key *key);
153
154void
155svga_screen_surface_destroy(struct svga_screen *svgascreen,
156                            const struct svga_host_surface_cache_key *key,
157                            boolean to_invalidate,
158                            struct svga_winsys_surface **handle);
159
160void
161svga_screen_cache_dump(const struct svga_screen *svgascreen);
162
163unsigned
164svga_surface_size(const struct svga_host_surface_cache_key *key);
165
166
167#endif /* SVGA_SCREEN_CACHE_H_ */
168