2 * IWineD3DQuery implementation
4 * Copyright 2005 Oliver Stieber
5 * Copyright 2007-2008 Stefan Dösinger for CodeWeavers
6 * Copyright 2009 Henri Verbeet for CodeWeavers.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
25 #include "wined3d_private.h"
27 WINE_DEFAULT_DEBUG_CHANNEL(d3d);
29 BOOL wined3d_event_query_supported(const struct wined3d_gl_info *gl_info)
31 return gl_info->supported[ARB_SYNC] || gl_info->supported[NV_FENCE] || gl_info->supported[APPLE_FENCE];
34 void wined3d_event_query_destroy(struct wined3d_event_query *query)
36 if (query->context) context_free_event_query(query);
37 HeapFree(GetProcessHeap(), 0, query);
40 enum wined3d_event_query_result wined3d_event_query_test(struct wined3d_event_query *query, IWineD3DDeviceImpl *device)
42 struct wined3d_context *context;
43 const struct wined3d_gl_info *gl_info;
44 enum wined3d_event_query_result ret;
47 TRACE("(%p) : device %p\n", query, device);
49 if (query->context == NULL)
51 TRACE("Query not started\n");
52 return WINED3D_EVENT_QUERY_NOT_STARTED;
55 if (!query->context->gl_info->supported[ARB_SYNC] && query->context->tid != GetCurrentThreadId())
57 WARN("Event query tested from wrong thread\n");
58 return WINED3D_EVENT_QUERY_WRONG_THREAD;
61 context = context_acquire(device, query->context->current_rt);
62 gl_info = context->gl_info;
66 if (gl_info->supported[ARB_SYNC])
68 GLenum gl_ret = GL_EXTCALL(glClientWaitSync(query->object.sync, 0, 0));
69 checkGLcall("glClientWaitSync");
73 case GL_ALREADY_SIGNALED:
74 case GL_CONDITION_SATISFIED:
75 ret = WINED3D_EVENT_QUERY_OK;
78 case GL_TIMEOUT_EXPIRED:
79 ret = WINED3D_EVENT_QUERY_WAITING;
84 ERR("glClientWaitSync returned %#x.\n", gl_ret);
85 ret = WINED3D_EVENT_QUERY_ERROR;
88 else if (gl_info->supported[APPLE_FENCE])
90 fence_result = GL_EXTCALL(glTestFenceAPPLE(query->object.id));
91 checkGLcall("glTestFenceAPPLE");
92 if (fence_result) ret = WINED3D_EVENT_QUERY_OK;
93 else ret = WINED3D_EVENT_QUERY_WAITING;
95 else if (gl_info->supported[NV_FENCE])
97 fence_result = GL_EXTCALL(glTestFenceNV(query->object.id));
98 checkGLcall("glTestFenceNV");
99 if (fence_result) ret = WINED3D_EVENT_QUERY_OK;
100 else ret = WINED3D_EVENT_QUERY_WAITING;
104 ERR("Event query created despite lack of GL support\n");
105 ret = WINED3D_EVENT_QUERY_ERROR;
110 context_release(context);
114 enum wined3d_event_query_result wined3d_event_query_finish(struct wined3d_event_query *query, IWineD3DDeviceImpl *device)
116 struct wined3d_context *context;
117 const struct wined3d_gl_info *gl_info;
118 enum wined3d_event_query_result ret;
120 TRACE("(%p)\n", query);
124 TRACE("Query not started\n");
125 return WINED3D_EVENT_QUERY_NOT_STARTED;
127 gl_info = query->context->gl_info;
129 if (query->context->tid != GetCurrentThreadId() && !gl_info->supported[ARB_SYNC])
131 /* A glFinish does not reliably wait for draws in other contexts. The caller has
132 * to find its own way to cope with the thread switch
134 WARN("Event query finished from wrong thread\n");
135 return WINED3D_EVENT_QUERY_WRONG_THREAD;
138 context = context_acquire(device, query->context->current_rt);
141 if (gl_info->supported[ARB_SYNC])
143 GLenum gl_ret = GL_EXTCALL(glClientWaitSync(query->object.sync, 0, ~(GLuint64)0));
144 checkGLcall("glClientWaitSync");
148 case GL_ALREADY_SIGNALED:
149 case GL_CONDITION_SATISFIED:
150 ret = WINED3D_EVENT_QUERY_OK;
153 /* We don't expect a timeout for a ~584 year wait */
155 ERR("glClientWaitSync returned %#x.\n", gl_ret);
156 ret = WINED3D_EVENT_QUERY_ERROR;
159 else if (context->gl_info->supported[APPLE_FENCE])
161 GL_EXTCALL(glFinishFenceAPPLE(query->object.id));
162 checkGLcall("glFinishFenceAPPLE");
163 ret = WINED3D_EVENT_QUERY_OK;
165 else if (context->gl_info->supported[NV_FENCE])
167 GL_EXTCALL(glFinishFenceNV(query->object.id));
168 checkGLcall("glFinishFenceNV");
169 ret = WINED3D_EVENT_QUERY_OK;
173 ERR("Event query created without GL support\n");
174 ret = WINED3D_EVENT_QUERY_ERROR;
178 context_release(context);
182 void wined3d_event_query_issue(struct wined3d_event_query *query, IWineD3DDeviceImpl *device)
184 const struct wined3d_gl_info *gl_info;
185 struct wined3d_context *context;
189 if (!query->context->gl_info->supported[ARB_SYNC] && query->context->tid != GetCurrentThreadId())
191 context_free_event_query(query);
192 context = context_acquire(device, NULL);
193 context_alloc_event_query(context, query);
197 context = context_acquire(device, query->context->current_rt);
202 context = context_acquire(device, NULL);
203 context_alloc_event_query(context, query);
206 gl_info = context->gl_info;
210 if (gl_info->supported[ARB_SYNC])
212 if (query->object.sync) GL_EXTCALL(glDeleteSync(query->object.sync));
213 checkGLcall("glDeleteSync");
214 query->object.sync = GL_EXTCALL(glFenceSync(GL_SYNC_GPU_COMMANDS_COMPLETE, 0));
215 checkGLcall("glFenceSync");
217 else if (gl_info->supported[APPLE_FENCE])
219 GL_EXTCALL(glSetFenceAPPLE(query->object.id));
220 checkGLcall("glSetFenceAPPLE");
222 else if (gl_info->supported[NV_FENCE])
224 GL_EXTCALL(glSetFenceNV(query->object.id, GL_ALL_COMPLETED_NV));
225 checkGLcall("glSetFenceNV");
230 context_release(context);
235 * http://www.gris.uni-tuebingen.de/~bartz/Publications/paper/hww98.pdf
236 * http://oss.sgi.com/projects/ogl-sample/registry/ARB/occlusion_query.txt
239 /* *******************************************
240 IWineD3DQuery IUnknown parts follow
241 ******************************************* */
242 static HRESULT WINAPI IWineD3DQueryImpl_QueryInterface(IWineD3DQuery *iface, REFIID riid, LPVOID *ppobj)
244 IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
245 TRACE("(%p)->(%s,%p)\n",This,debugstr_guid(riid),ppobj);
246 if (IsEqualGUID(riid, &IID_IUnknown)
247 || IsEqualGUID(riid, &IID_IWineD3DBase)
248 || IsEqualGUID(riid, &IID_IWineD3DQuery)) {
249 IUnknown_AddRef(iface);
254 return E_NOINTERFACE;
257 static ULONG WINAPI IWineD3DQueryImpl_AddRef(IWineD3DQuery *iface) {
258 IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
259 TRACE("(%p) : AddRef increasing from %d\n", This, This->ref);
260 return InterlockedIncrement(&This->ref);
263 static ULONG WINAPI IWineD3DQueryImpl_Release(IWineD3DQuery *iface) {
264 IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
266 TRACE("(%p) : Releasing from %d\n", This, This->ref);
267 ref = InterlockedDecrement(&This->ref);
269 /* Queries are specific to the GL context that created them. Not
270 * deleting the query will obviously leak it, but that's still better
271 * than potentially deleting a different query with the same id in this
272 * context, and (still) leaking the actual query. */
273 if (This->type == WINED3DQUERYTYPE_EVENT)
275 struct wined3d_event_query *query = This->extendedData;
276 if (query) wined3d_event_query_destroy(query);
278 else if (This->type == WINED3DQUERYTYPE_OCCLUSION)
280 struct wined3d_occlusion_query *query = This->extendedData;
282 if (query->context) context_free_occlusion_query(query);
283 HeapFree(GetProcessHeap(), 0, This->extendedData);
286 HeapFree(GetProcessHeap(), 0, This);
291 /* *******************************************
292 IWineD3DQuery IWineD3DQuery parts follow
293 ******************************************* */
294 static HRESULT WINAPI IWineD3DQueryImpl_GetParent(IWineD3DQuery *iface, IUnknown **parent)
296 TRACE("iface %p, parent %p.\n", iface, parent);
298 *parent = (IUnknown *)parent;
299 IUnknown_AddRef(*parent);
301 TRACE("Returning %p.\n", *parent);
306 static HRESULT WINAPI IWineD3DOcclusionQueryImpl_GetData(IWineD3DQuery* iface, void* pData, DWORD dwSize, DWORD dwGetDataFlags) {
307 IWineD3DQueryImpl *This = (IWineD3DQueryImpl *) iface;
308 struct wined3d_occlusion_query *query = This->extendedData;
309 IWineD3DDeviceImpl *device = This->device;
310 const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
311 struct wined3d_context *context;
317 TRACE("(%p) : type D3DQUERY_OCCLUSION, pData %p, dwSize %#x, dwGetDataFlags %#x\n", This, pData, dwSize, dwGetDataFlags);
319 if (!query->context) This->state = QUERY_CREATED;
321 if (This->state == QUERY_CREATED)
323 /* D3D allows GetData on a new query, OpenGL doesn't. So just invent the data ourselves */
324 TRACE("Query wasn't yet started, returning S_OK\n");
329 if (This->state == QUERY_BUILDING)
331 /* Msdn says this returns an error, but our tests show that S_FALSE is returned */
332 TRACE("Query is building, returning S_FALSE\n");
336 if (!gl_info->supported[ARB_OCCLUSION_QUERY])
338 WARN("(%p) : Occlusion queries not supported. Returning 1.\n", This);
343 if (query->context->tid != GetCurrentThreadId())
345 FIXME("%p Wrong thread, returning 1.\n", This);
350 context = context_acquire(This->device, query->context->current_rt);
354 GL_EXTCALL(glGetQueryObjectuivARB(query->id, GL_QUERY_RESULT_AVAILABLE_ARB, &available));
355 checkGLcall("glGetQueryObjectuivARB(GL_QUERY_RESULT_AVAILABLE)");
356 TRACE("(%p) : available %d.\n", This, available);
362 GL_EXTCALL(glGetQueryObjectuivARB(query->id, GL_QUERY_RESULT_ARB, &samples));
363 checkGLcall("glGetQueryObjectuivARB(GL_QUERY_RESULT)");
364 TRACE("(%p) : Returning %d samples.\n", This, samples);
376 context_release(context);
381 static HRESULT WINAPI IWineD3DEventQueryImpl_GetData(IWineD3DQuery* iface, void* pData, DWORD dwSize, DWORD dwGetDataFlags) {
382 IWineD3DQueryImpl *This = (IWineD3DQueryImpl *) iface;
383 struct wined3d_event_query *query = This->extendedData;
385 enum wined3d_event_query_result ret;
387 TRACE("(%p) : type D3DQUERY_EVENT, pData %p, dwSize %#x, dwGetDataFlags %#x\n", This, pData, dwSize, dwGetDataFlags);
389 if (!pData || !dwSize) return S_OK;
392 WARN("(%p): Event query not supported by GL, reporting GPU idle\n", This);
397 ret = wined3d_event_query_test(query, This->device);
400 case WINED3D_EVENT_QUERY_OK:
401 case WINED3D_EVENT_QUERY_NOT_STARTED:
405 case WINED3D_EVENT_QUERY_WAITING:
409 case WINED3D_EVENT_QUERY_WRONG_THREAD:
410 FIXME("(%p) Wrong thread, reporting GPU idle.\n", This);
414 case WINED3D_EVENT_QUERY_ERROR:
415 ERR("The GL event query failed, returning D3DERR_INVALIDCALL\n");
416 return WINED3DERR_INVALIDCALL;
422 static DWORD WINAPI IWineD3DEventQueryImpl_GetDataSize(IWineD3DQuery* iface){
423 TRACE("(%p) : type D3DQUERY_EVENT\n", iface);
428 static DWORD WINAPI IWineD3DOcclusionQueryImpl_GetDataSize(IWineD3DQuery* iface){
429 TRACE("(%p) : type D3DQUERY_OCCLUSION\n", iface);
431 return sizeof(DWORD);
434 static WINED3DQUERYTYPE WINAPI IWineD3DQueryImpl_GetType(IWineD3DQuery* iface){
435 IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
439 static HRESULT WINAPI IWineD3DEventQueryImpl_Issue(IWineD3DQuery* iface, DWORD dwIssueFlags) {
440 IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
442 TRACE("(%p) : dwIssueFlags %#x, type D3DQUERY_EVENT\n", This, dwIssueFlags);
443 if (dwIssueFlags & WINED3DISSUE_END)
445 struct wined3d_event_query *query = This->extendedData;
447 /* Faked event query support */
448 if (!query) return WINED3D_OK;
450 wined3d_event_query_issue(query, This->device);
452 else if(dwIssueFlags & WINED3DISSUE_BEGIN)
454 /* Started implicitly at device creation */
455 ERR("Event query issued with START flag - what to do?\n");
458 if(dwIssueFlags & WINED3DISSUE_BEGIN) {
459 This->state = QUERY_BUILDING;
461 This->state = QUERY_SIGNALLED;
467 static HRESULT WINAPI IWineD3DOcclusionQueryImpl_Issue(IWineD3DQuery* iface, DWORD dwIssueFlags) {
468 IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
469 IWineD3DDeviceImpl *device = This->device;
470 const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
472 if (gl_info->supported[ARB_OCCLUSION_QUERY])
474 struct wined3d_occlusion_query *query = This->extendedData;
475 struct wined3d_context *context;
477 /* This is allowed according to msdn and our tests. Reset the query and restart */
478 if (dwIssueFlags & WINED3DISSUE_BEGIN)
480 if (This->state == QUERY_BUILDING)
482 if (query->context->tid != GetCurrentThreadId())
484 FIXME("Wrong thread, can't restart query.\n");
486 context_free_occlusion_query(query);
487 context = context_acquire(This->device, NULL);
488 context_alloc_occlusion_query(context, query);
492 context = context_acquire(This->device, query->context->current_rt);
495 GL_EXTCALL(glEndQueryARB(GL_SAMPLES_PASSED_ARB));
496 checkGLcall("glEndQuery()");
502 if (query->context) context_free_occlusion_query(query);
503 context = context_acquire(This->device, NULL);
504 context_alloc_occlusion_query(context, query);
508 GL_EXTCALL(glBeginQueryARB(GL_SAMPLES_PASSED_ARB, query->id));
509 checkGLcall("glBeginQuery()");
512 context_release(context);
514 if (dwIssueFlags & WINED3DISSUE_END) {
515 /* Msdn says _END on a non-building occlusion query returns an error, but
516 * our tests show that it returns OK. But OpenGL doesn't like it, so avoid
517 * generating an error
519 if (This->state == QUERY_BUILDING)
521 if (query->context->tid != GetCurrentThreadId())
523 FIXME("Wrong thread, can't end query.\n");
527 context = context_acquire(This->device, query->context->current_rt);
530 GL_EXTCALL(glEndQueryARB(GL_SAMPLES_PASSED_ARB));
531 checkGLcall("glEndQuery()");
534 context_release(context);
539 FIXME("(%p) : Occlusion queries not supported\n", This);
542 if(dwIssueFlags & WINED3DISSUE_BEGIN) {
543 This->state = QUERY_BUILDING;
545 This->state = QUERY_SIGNALLED;
547 return WINED3D_OK; /* can be WINED3DERR_INVALIDCALL. */
550 static const IWineD3DQueryVtbl IWineD3DEventQuery_Vtbl =
552 /*** IUnknown methods ***/
553 IWineD3DQueryImpl_QueryInterface,
554 IWineD3DQueryImpl_AddRef,
555 IWineD3DQueryImpl_Release,
556 /*** IWineD3Dquery methods ***/
557 IWineD3DQueryImpl_GetParent,
558 IWineD3DEventQueryImpl_GetData,
559 IWineD3DEventQueryImpl_GetDataSize,
560 IWineD3DQueryImpl_GetType,
561 IWineD3DEventQueryImpl_Issue
564 static const IWineD3DQueryVtbl IWineD3DOcclusionQuery_Vtbl =
566 /*** IUnknown methods ***/
567 IWineD3DQueryImpl_QueryInterface,
568 IWineD3DQueryImpl_AddRef,
569 IWineD3DQueryImpl_Release,
570 /*** IWineD3Dquery methods ***/
571 IWineD3DQueryImpl_GetParent,
572 IWineD3DOcclusionQueryImpl_GetData,
573 IWineD3DOcclusionQueryImpl_GetDataSize,
574 IWineD3DQueryImpl_GetType,
575 IWineD3DOcclusionQueryImpl_Issue
578 HRESULT query_init(IWineD3DQueryImpl *query, IWineD3DDeviceImpl *device,
579 WINED3DQUERYTYPE type, IUnknown *parent)
581 const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
585 case WINED3DQUERYTYPE_OCCLUSION:
586 TRACE("Occlusion query.\n");
587 if (!gl_info->supported[ARB_OCCLUSION_QUERY])
589 WARN("Unsupported in local OpenGL implementation: ARB_OCCLUSION_QUERY.\n");
590 return WINED3DERR_NOTAVAILABLE;
592 query->lpVtbl = &IWineD3DOcclusionQuery_Vtbl;
593 query->extendedData = HeapAlloc(GetProcessHeap(), 0, sizeof(struct wined3d_occlusion_query));
594 if (!query->extendedData)
596 ERR("Failed to allocate occlusion query extended data.\n");
597 return E_OUTOFMEMORY;
599 ((struct wined3d_occlusion_query *)query->extendedData)->context = NULL;
602 case WINED3DQUERYTYPE_EVENT:
603 TRACE("Event query.\n");
604 if (!wined3d_event_query_supported(gl_info))
606 /* Half-Life 2 needs this query. It does not render the main
607 * menu correctly otherwise. Pretend to support it, faking
608 * this query does not do much harm except potentially
609 * lowering performance. */
610 FIXME("Event query: Unimplemented, but pretending to be supported.\n");
612 query->lpVtbl = &IWineD3DEventQuery_Vtbl;
613 query->extendedData = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct wined3d_event_query));
614 if (!query->extendedData)
616 ERR("Failed to allocate event query memory.\n");
617 return E_OUTOFMEMORY;
621 case WINED3DQUERYTYPE_VCACHE:
622 case WINED3DQUERYTYPE_RESOURCEMANAGER:
623 case WINED3DQUERYTYPE_VERTEXSTATS:
624 case WINED3DQUERYTYPE_TIMESTAMP:
625 case WINED3DQUERYTYPE_TIMESTAMPDISJOINT:
626 case WINED3DQUERYTYPE_TIMESTAMPFREQ:
627 case WINED3DQUERYTYPE_PIPELINETIMINGS:
628 case WINED3DQUERYTYPE_INTERFACETIMINGS:
629 case WINED3DQUERYTYPE_VERTEXTIMINGS:
630 case WINED3DQUERYTYPE_PIXELTIMINGS:
631 case WINED3DQUERYTYPE_BANDWIDTHTIMINGS:
632 case WINED3DQUERYTYPE_CACHEUTILIZATION:
634 FIXME("Unhandled query type %#x.\n", type);
635 return WINED3DERR_NOTAVAILABLE;
639 query->state = QUERY_CREATED;
640 query->device = device;
641 query->parent = parent;