80d5dfc3ed49f107bc07c059a02012c614b61989
[mesa.git] / src / gallium / winsys / svga / drm / vmw_buffer.c
1 /**********************************************************
2 * Copyright 2009 VMware, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person
5 * obtaining a copy of this software and associated documentation
6 * files (the "Software"), to deal in the Software without
7 * restriction, including without limitation the rights to use, copy,
8 * modify, merge, publish, distribute, sublicense, and/or sell copies
9 * of the Software, and to permit persons to whom the Software is
10 * furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be
13 * included in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
19 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 * SOFTWARE.
23 *
24 **********************************************************/
25
26 /**
27 * @file
28 * SVGA buffer manager for Guest Memory Regions (GMRs).
29 *
30 * GMRs are used for pixel and vertex data upload/download to/from the virtual
31 * SVGA hardware. There is a limited number of GMRs available, and
32 * creating/destroying them is also a slow operation so we must suballocate
33 * them.
34 *
35 * This file implements a pipebuffer library's buffer manager, so that we can
36 * use pipepbuffer's suballocation, fencing, and debugging facilities with GMRs.
37 *
38 * @author Jose Fonseca <jfonseca@vmware.com>
39 */
40
41
42 #include "svga_cmd.h"
43
44 #include "util/u_inlines.h"
45 #include "util/u_memory.h"
46 #include "pipebuffer/pb_buffer.h"
47 #include "pipebuffer/pb_bufmgr.h"
48
49 #include "svga_winsys.h"
50
51 #include "vmw_screen.h"
52 #include "vmw_buffer.h"
53
54
55 struct vmw_gmr_bufmgr;
56
57
58 struct vmw_gmr_buffer
59 {
60 struct pb_buffer base;
61
62 struct vmw_gmr_bufmgr *mgr;
63
64 struct vmw_region *region;
65 void *map;
66
67 #ifdef DEBUG
68 struct pipe_fence_handle *last_fence;
69 #endif
70 };
71
72
73 extern const struct pb_vtbl vmw_gmr_buffer_vtbl;
74
75
76 static INLINE struct vmw_gmr_buffer *
77 vmw_gmr_buffer(struct pb_buffer *buf)
78 {
79 assert(buf);
80 assert(buf->vtbl == &vmw_gmr_buffer_vtbl);
81 return (struct vmw_gmr_buffer *)buf;
82 }
83
84
85 struct vmw_gmr_bufmgr
86 {
87 struct pb_manager base;
88
89 struct vmw_winsys_screen *vws;
90 };
91
92
93 static INLINE struct vmw_gmr_bufmgr *
94 vmw_gmr_bufmgr(struct pb_manager *mgr)
95 {
96 assert(mgr);
97 return (struct vmw_gmr_bufmgr *)mgr;
98 }
99
100
101 static void
102 vmw_gmr_buffer_destroy(struct pb_buffer *_buf)
103 {
104 struct vmw_gmr_buffer *buf = vmw_gmr_buffer(_buf);
105
106 #ifdef DEBUG
107 if(buf->last_fence) {
108 struct svga_winsys_screen *sws = &buf->mgr->vws->base;
109 assert(sws->fence_signalled(sws, buf->last_fence, 0) == 0);
110 }
111 #endif
112
113 vmw_ioctl_region_unmap(buf->region);
114
115 vmw_ioctl_region_destroy(buf->region);
116
117 FREE(buf);
118 }
119
120
121 static void *
122 vmw_gmr_buffer_map(struct pb_buffer *_buf,
123 unsigned flags,
124 void *flush_ctx)
125 {
126 struct vmw_gmr_buffer *buf = vmw_gmr_buffer(_buf);
127 return buf->map;
128 }
129
130
131 static void
132 vmw_gmr_buffer_unmap(struct pb_buffer *_buf)
133 {
134 /* Do nothing */
135 (void)_buf;
136 }
137
138
139 static void
140 vmw_gmr_buffer_get_base_buffer(struct pb_buffer *buf,
141 struct pb_buffer **base_buf,
142 unsigned *offset)
143 {
144 *base_buf = buf;
145 *offset = 0;
146 }
147
148
149 static enum pipe_error
150 vmw_gmr_buffer_validate( struct pb_buffer *_buf,
151 struct pb_validate *vl,
152 unsigned flags )
153 {
154 /* Always pinned */
155 return PIPE_OK;
156 }
157
158
159 static void
160 vmw_gmr_buffer_fence( struct pb_buffer *_buf,
161 struct pipe_fence_handle *fence )
162 {
163 /* We don't need to do anything, as the pipebuffer library
164 * will take care of delaying the destruction of fenced buffers */
165 #ifdef DEBUG
166 struct vmw_gmr_buffer *buf = vmw_gmr_buffer(_buf);
167 if(fence)
168 buf->last_fence = fence;
169 #endif
170 }
171
172
173 const struct pb_vtbl vmw_gmr_buffer_vtbl = {
174 vmw_gmr_buffer_destroy,
175 vmw_gmr_buffer_map,
176 vmw_gmr_buffer_unmap,
177 vmw_gmr_buffer_validate,
178 vmw_gmr_buffer_fence,
179 vmw_gmr_buffer_get_base_buffer
180 };
181
182
183 static struct pb_buffer *
184 vmw_gmr_bufmgr_create_buffer(struct pb_manager *_mgr,
185 pb_size size,
186 const struct pb_desc *desc)
187 {
188 struct vmw_gmr_bufmgr *mgr = vmw_gmr_bufmgr(_mgr);
189 struct vmw_winsys_screen *vws = mgr->vws;
190 struct vmw_gmr_buffer *buf;
191
192 buf = CALLOC_STRUCT(vmw_gmr_buffer);
193 if(!buf)
194 goto error1;
195
196 pipe_reference_init(&buf->base.base.reference, 1);
197 buf->base.base.alignment = desc->alignment;
198 buf->base.base.usage = desc->usage;
199 buf->base.base.size = size;
200 buf->base.vtbl = &vmw_gmr_buffer_vtbl;
201 buf->mgr = mgr;
202
203 buf->region = vmw_ioctl_region_create(vws, size);
204 if(!buf->region)
205 goto error2;
206
207 buf->map = vmw_ioctl_region_map(buf->region);
208 if(!buf->map)
209 goto error3;
210
211 return &buf->base;
212
213 error3:
214 vmw_ioctl_region_destroy(buf->region);
215 error2:
216 FREE(buf);
217 error1:
218 return NULL;
219 }
220
221
222 static void
223 vmw_gmr_bufmgr_flush(struct pb_manager *mgr)
224 {
225 /* No-op */
226 }
227
228
229 static void
230 vmw_gmr_bufmgr_destroy(struct pb_manager *_mgr)
231 {
232 struct vmw_gmr_bufmgr *mgr = vmw_gmr_bufmgr(_mgr);
233 FREE(mgr);
234 }
235
236
237 struct pb_manager *
238 vmw_gmr_bufmgr_create(struct vmw_winsys_screen *vws)
239 {
240 struct vmw_gmr_bufmgr *mgr;
241
242 mgr = CALLOC_STRUCT(vmw_gmr_bufmgr);
243 if(!mgr)
244 return NULL;
245
246 mgr->base.destroy = vmw_gmr_bufmgr_destroy;
247 mgr->base.create_buffer = vmw_gmr_bufmgr_create_buffer;
248 mgr->base.flush = vmw_gmr_bufmgr_flush;
249
250 mgr->vws = vws;
251
252 return &mgr->base;
253 }
254
255
256 boolean
257 vmw_gmr_bufmgr_region_ptr(struct pb_buffer *buf,
258 struct SVGAGuestPtr *ptr)
259 {
260 struct pb_buffer *base_buf;
261 unsigned offset = 0;
262 struct vmw_gmr_buffer *gmr_buf;
263
264 pb_get_base_buffer( buf, &base_buf, &offset );
265
266 gmr_buf = vmw_gmr_buffer(base_buf);
267 if(!gmr_buf)
268 return FALSE;
269
270 *ptr = vmw_ioctl_region_ptr(gmr_buf->region);
271
272 ptr->offset += offset;
273
274 return TRUE;
275 }