dlls/wined3d/query.c

   1 /*
   2  * IWineD3DQuery implementation
   3  *
   4  * Copyright 2005 Oliver Stieber
   5  * Copyright 2007-2008 Stefan Dösinger for CodeWeavers
   6  * Copyright 2009 Henri Verbeet for CodeWeavers.
   7  *
   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.
  12  *
  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.
  17  *
  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
  21  */
  22
  23
  24 #include "config.h"
  25 #include "wined3d_private.h"
  26
  27 /*
  28  * Occlusion Queries:
  29  * http://www.gris.uni-tuebingen.de/~bartz/Publications/paper/hww98.pdf
  30  * http://oss.sgi.com/projects/ogl-sample/registry/ARB/occlusion_query.txt
  31  */
  32
  33 WINE_DEFAULT_DEBUG_CHANNEL(d3d);
  34 #define GLINFO_LOCATION (*gl_info)
  35
  36 /* *******************************************
  37    IWineD3DQuery IUnknown parts follow
  38    ******************************************* */
  39 static HRESULT  WINAPI IWineD3DQueryImpl_QueryInterface(IWineD3DQuery *iface, REFIID riid, LPVOID *ppobj)
  40 {
  41     IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
  42     TRACE("(%p)->(%s,%p)\n",This,debugstr_guid(riid),ppobj);
  43     if (IsEqualGUID(riid, &IID_IUnknown)
  44         || IsEqualGUID(riid, &IID_IWineD3DBase)
  45         || IsEqualGUID(riid, &IID_IWineD3DQuery)) {
  46         IUnknown_AddRef(iface);
  47         *ppobj = This;
  48         return S_OK;
  49     }
  50     *ppobj = NULL;
  51     return E_NOINTERFACE;
  52 }
  53
  54 static ULONG  WINAPI IWineD3DQueryImpl_AddRef(IWineD3DQuery *iface) {
  55     IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
  56     TRACE("(%p) : AddRef increasing from %d\n", This, This->ref);
  57     return InterlockedIncrement(&This->ref);
  58 }
  59
  60 static ULONG  WINAPI IWineD3DQueryImpl_Release(IWineD3DQuery *iface) {
  61     IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
  62     ULONG ref;
  63     TRACE("(%p) : Releasing from %d\n", This, This->ref);
  64     ref = InterlockedDecrement(&This->ref);
  65     if (ref == 0) {
  66         /* Queries are specific to the GL context that created them. Not
  67          * deleting the query will obviously leak it, but that's still better
  68          * than potentially deleting a different query with the same id in this
  69          * context, and (still) leaking the actual query. */
  70         if (This->type == WINED3DQUERYTYPE_EVENT)
  71         {
  72             struct wined3d_event_query *query = This->extendedData;
  73
  74             if (query->context) context_free_event_query(query);
  75         }
  76         else if (This->type == WINED3DQUERYTYPE_OCCLUSION)
  77         {
  78             struct wined3d_occlusion_query *query = This->extendedData;
  79
  80             if (query->context) context_free_occlusion_query(query);
  81         }
  82
  83         HeapFree(GetProcessHeap(), 0, This->extendedData);
  84         HeapFree(GetProcessHeap(), 0, This);
  85     }
  86     return ref;
  87 }
  88
  89 /* *******************************************
  90    IWineD3DQuery IWineD3DQuery parts follow
  91    ******************************************* */
  92 static HRESULT WINAPI IWineD3DQueryImpl_GetParent(IWineD3DQuery *iface, IUnknown **parent)
  93 {
  94     TRACE("iface %p, parent %p.\n", iface, parent);
  95
  96     *parent = (IUnknown *)parent;
  97     IUnknown_AddRef(*parent);
  98
  99     TRACE("Returning %p.\n", *parent);
 100
 101     return WINED3D_OK;
 102 }
 103
 104 static HRESULT  WINAPI IWineD3DOcclusionQueryImpl_GetData(IWineD3DQuery* iface, void* pData, DWORD dwSize, DWORD dwGetDataFlags) {
 105     IWineD3DQueryImpl *This = (IWineD3DQueryImpl *) iface;
 106     struct wined3d_occlusion_query *query = This->extendedData;
 107     IWineD3DDeviceImpl *device = This->device;
 108     const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
 109     struct wined3d_context *context;
 110     DWORD* data = pData;
 111     GLuint available;
 112     GLuint samples;
 113     HRESULT res;
 114
 115     TRACE("(%p) : type D3DQUERY_OCCLUSION, pData %p, dwSize %#x, dwGetDataFlags %#x\n", This, pData, dwSize, dwGetDataFlags);
 116
 117     if (!query->context) This->state = QUERY_CREATED;
 118
 119     if (This->state == QUERY_CREATED)
 120     {
 121         /* D3D allows GetData on a new query, OpenGL doesn't. So just invent the data ourselves */
 122         TRACE("Query wasn't yet started, returning S_OK\n");
 123         if(data) *data = 0;
 124         return S_OK;
 125     }
 126
 127     if (This->state == QUERY_BUILDING)
 128     {
 129         /* Msdn says this returns an error, but our tests show that S_FALSE is returned */
 130         TRACE("Query is building, returning S_FALSE\n");
 131         return S_FALSE;
 132     }
 133
 134     if (!gl_info->supported[ARB_OCCLUSION_QUERY])
 135     {
 136         WARN("(%p) : Occlusion queries not supported. Returning 1.\n", This);
 137         *data = 1;
 138         return S_OK;
 139     }
 140
 141     if (query->context->tid != GetCurrentThreadId())
 142     {
 143         FIXME("%p Wrong thread, returning 1.\n", This);
 144         *data = 1;
 145         return S_OK;
 146     }
 147
 148     context = context_acquire(This->device, query->context->current_rt, CTXUSAGE_RESOURCELOAD);
 149
 150     ENTER_GL();
 151
 152     GL_EXTCALL(glGetQueryObjectuivARB(query->id, GL_QUERY_RESULT_AVAILABLE_ARB, &available));
 153     checkGLcall("glGetQueryObjectuivARB(GL_QUERY_RESULT_AVAILABLE)");
 154     TRACE("(%p) : available %d.\n", This, available);
 155
 156     if (available)
 157     {
 158         if (data)
 159         {
 160             GL_EXTCALL(glGetQueryObjectuivARB(query->id, GL_QUERY_RESULT_ARB, &samples));
 161             checkGLcall("glGetQueryObjectuivARB(GL_QUERY_RESULT)");
 162             TRACE("(%p) : Returning %d samples.\n", This, samples);
 163             *data = samples;
 164         }
 165         res = S_OK;
 166     }
 167     else
 168     {
 169         res = S_FALSE;
 170     }
 171
 172     LEAVE_GL();
 173
 174     context_release(context);
 175
 176     return res;
 177 }
 178
 179 static HRESULT  WINAPI IWineD3DEventQueryImpl_GetData(IWineD3DQuery* iface, void* pData, DWORD dwSize, DWORD dwGetDataFlags) {
 180     IWineD3DQueryImpl *This = (IWineD3DQueryImpl *) iface;
 181     struct wined3d_event_query *query = This->extendedData;
 182     const struct wined3d_gl_info *gl_info;
 183     struct wined3d_context *context;
 184     BOOL *data = pData;
 185
 186     TRACE("(%p) : type D3DQUERY_EVENT, pData %p, dwSize %#x, dwGetDataFlags %#x\n", This, pData, dwSize, dwGetDataFlags);
 187
 188     if (!pData || !dwSize) return S_OK;
 189
 190     if (!query->context)
 191     {
 192         TRACE("Query not started, returning TRUE.\n");
 193         *data = TRUE;
 194
 195         return S_OK;
 196     }
 197
 198     if (query->context->tid != GetCurrentThreadId())
 199     {
 200         /* See comment in IWineD3DQuery::Issue, event query codeblock */
 201         FIXME("Wrong thread, reporting GPU idle.\n");
 202         *data = TRUE;
 203
 204         return S_OK;
 205     }
 206
 207     context = context_acquire(This->device, query->context->current_rt, CTXUSAGE_RESOURCELOAD);
 208     gl_info = context->gl_info;
 209
 210     ENTER_GL();
 211
 212     if (gl_info->supported[APPLE_FENCE])
 213     {
 214         *data = GL_EXTCALL(glTestFenceAPPLE(query->id));
 215         checkGLcall("glTestFenceAPPLE");
 216     }
 217     else if (gl_info->supported[NV_FENCE])
 218     {
 219         *data = GL_EXTCALL(glTestFenceNV(query->id));
 220         checkGLcall("glTestFenceNV");
 221     }
 222     else
 223     {
 224         WARN("(%p): reporting GPU idle\n", This);
 225         *data = TRUE;
 226     }
 227
 228     LEAVE_GL();
 229
 230     context_release(context);
 231
 232     return S_OK;
 233 }
 234
 235 static DWORD  WINAPI IWineD3DEventQueryImpl_GetDataSize(IWineD3DQuery* iface){
 236     TRACE("(%p) : type D3DQUERY_EVENT\n", iface);
 237
 238     return sizeof(BOOL);
 239 }
 240
 241 static DWORD  WINAPI IWineD3DOcclusionQueryImpl_GetDataSize(IWineD3DQuery* iface){
 242     TRACE("(%p) : type D3DQUERY_OCCLUSION\n", iface);
 243
 244     return sizeof(DWORD);
 245 }
 246
 247 static WINED3DQUERYTYPE  WINAPI IWineD3DQueryImpl_GetType(IWineD3DQuery* iface){
 248     IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
 249     return This->type;
 250 }
 251
 252
 253 static HRESULT  WINAPI IWineD3DEventQueryImpl_Issue(IWineD3DQuery* iface,  DWORD dwIssueFlags) {
 254     IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
 255
 256     TRACE("(%p) : dwIssueFlags %#x, type D3DQUERY_EVENT\n", This, dwIssueFlags);
 257     if (dwIssueFlags & WINED3DISSUE_END)
 258     {
 259         struct wined3d_event_query *query = This->extendedData;
 260         const struct wined3d_gl_info *gl_info;
 261         struct wined3d_context *context;
 262
 263         if (query->context)
 264         {
 265             if (query->context->tid != GetCurrentThreadId())
 266             {
 267                 context_free_event_query(query);
 268                 context = context_acquire(This->device, NULL, CTXUSAGE_RESOURCELOAD);
 269                 context_alloc_event_query(context, query);
 270             }
 271             else
 272             {
 273                 context = context_acquire(This->device, query->context->current_rt, CTXUSAGE_RESOURCELOAD);
 274             }
 275         }
 276         else
 277         {
 278             context = context_acquire(This->device, NULL, CTXUSAGE_RESOURCELOAD);
 279             context_alloc_event_query(context, query);
 280         }
 281
 282         gl_info = context->gl_info;
 283
 284         ENTER_GL();
 285
 286         if (gl_info->supported[APPLE_FENCE])
 287         {
 288             GL_EXTCALL(glSetFenceAPPLE(query->id));
 289             checkGLcall("glSetFenceAPPLE");
 290         }
 291         else if (gl_info->supported[NV_FENCE])
 292         {
 293             GL_EXTCALL(glSetFenceNV(query->id, GL_ALL_COMPLETED_NV));
 294             checkGLcall("glSetFenceNV");
 295         }
 296
 297         LEAVE_GL();
 298
 299         context_release(context);
 300     }
 301     else if(dwIssueFlags & WINED3DISSUE_BEGIN)
 302     {
 303         /* Started implicitly at device creation */
 304         ERR("Event query issued with START flag - what to do?\n");
 305     }
 306
 307     if(dwIssueFlags & WINED3DISSUE_BEGIN) {
 308         This->state = QUERY_BUILDING;
 309     } else {
 310         This->state = QUERY_SIGNALLED;
 311     }
 312
 313     return WINED3D_OK;
 314 }
 315
 316 static HRESULT  WINAPI IWineD3DOcclusionQueryImpl_Issue(IWineD3DQuery* iface,  DWORD dwIssueFlags) {
 317     IWineD3DQueryImpl *This = (IWineD3DQueryImpl *)iface;
 318     IWineD3DDeviceImpl *device = This->device;
 319     const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
 320
 321     if (gl_info->supported[ARB_OCCLUSION_QUERY])
 322     {
 323         struct wined3d_occlusion_query *query = This->extendedData;
 324         struct wined3d_context *context;
 325
 326         /* This is allowed according to msdn and our tests. Reset the query and restart */
 327         if (dwIssueFlags & WINED3DISSUE_BEGIN)
 328         {
 329             if (This->state == QUERY_BUILDING)
 330             {
 331                 if (query->context->tid != GetCurrentThreadId())
 332                 {
 333                     FIXME("Wrong thread, can't restart query.\n");
 334
 335                     context_free_occlusion_query(query);
 336                     context = context_acquire(This->device, NULL, CTXUSAGE_RESOURCELOAD);
 337                     context_alloc_occlusion_query(context, query);
 338                 }
 339                 else
 340                 {
 341                     context = context_acquire(This->device, query->context->current_rt, CTXUSAGE_RESOURCELOAD);
 342
 343                     ENTER_GL();
 344                     GL_EXTCALL(glEndQueryARB(GL_SAMPLES_PASSED_ARB));
 345                     checkGLcall("glEndQuery()");
 346                     LEAVE_GL();
 347                 }
 348             }
 349             else
 350             {
 351                 if (query->context) context_free_occlusion_query(query);
 352                 context = context_acquire(This->device, NULL, CTXUSAGE_RESOURCELOAD);
 353                 context_alloc_occlusion_query(context, query);
 354             }
 355
 356             ENTER_GL();
 357             GL_EXTCALL(glBeginQueryARB(GL_SAMPLES_PASSED_ARB, query->id));
 358             checkGLcall("glBeginQuery()");
 359             LEAVE_GL();
 360
 361             context_release(context);
 362         }
 363         if (dwIssueFlags & WINED3DISSUE_END) {
 364             /* Msdn says _END on a non-building occlusion query returns an error, but
 365              * our tests show that it returns OK. But OpenGL doesn't like it, so avoid
 366              * generating an error
 367              */
 368             if (This->state == QUERY_BUILDING)
 369             {
 370                 if (query->context->tid != GetCurrentThreadId())
 371                 {
 372                     FIXME("Wrong thread, can't end query.\n");
 373                 }
 374                 else
 375                 {
 376                     context = context_acquire(This->device, query->context->current_rt, CTXUSAGE_RESOURCELOAD);
 377
 378                     ENTER_GL();
 379                     GL_EXTCALL(glEndQueryARB(GL_SAMPLES_PASSED_ARB));
 380                     checkGLcall("glEndQuery()");
 381                     LEAVE_GL();
 382
 383                     context_release(context);
 384                 }
 385             }
 386         }
 387     } else {
 388         FIXME("(%p) : Occlusion queries not supported\n", This);
 389     }
 390
 391     if(dwIssueFlags & WINED3DISSUE_BEGIN) {
 392         This->state = QUERY_BUILDING;
 393     } else {
 394         This->state = QUERY_SIGNALLED;
 395     }
 396     return WINED3D_OK; /* can be WINED3DERR_INVALIDCALL.    */
 397 }
 398
 399 static const IWineD3DQueryVtbl IWineD3DEventQuery_Vtbl =
 400 {
 401     /*** IUnknown methods ***/
 402     IWineD3DQueryImpl_QueryInterface,
 403     IWineD3DQueryImpl_AddRef,
 404     IWineD3DQueryImpl_Release,
 405     /*** IWineD3Dquery methods ***/
 406     IWineD3DQueryImpl_GetParent,
 407     IWineD3DEventQueryImpl_GetData,
 408     IWineD3DEventQueryImpl_GetDataSize,
 409     IWineD3DQueryImpl_GetType,
 410     IWineD3DEventQueryImpl_Issue
 411 };
 412
 413 static const IWineD3DQueryVtbl IWineD3DOcclusionQuery_Vtbl =
 414 {
 415     /*** IUnknown methods ***/
 416     IWineD3DQueryImpl_QueryInterface,
 417     IWineD3DQueryImpl_AddRef,
 418     IWineD3DQueryImpl_Release,
 419     /*** IWineD3Dquery methods ***/
 420     IWineD3DQueryImpl_GetParent,
 421     IWineD3DOcclusionQueryImpl_GetData,
 422     IWineD3DOcclusionQueryImpl_GetDataSize,
 423     IWineD3DQueryImpl_GetType,
 424     IWineD3DOcclusionQueryImpl_Issue
 425 };
 426
 427 HRESULT query_init(IWineD3DQueryImpl *query, IWineD3DDeviceImpl *device,
 428         WINED3DQUERYTYPE type, IUnknown *parent)
 429 {
 430     const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
 431
 432     switch (type)
 433     {
 434         case WINED3DQUERYTYPE_OCCLUSION:
 435             TRACE("Occlusion query.\n");
 436             if (!gl_info->supported[ARB_OCCLUSION_QUERY])
 437             {
 438                 WARN("Unsupported in local OpenGL implementation: ARB_OCCLUSION_QUERY.\n");
 439                 return WINED3DERR_NOTAVAILABLE;
 440             }
 441             query->lpVtbl = &IWineD3DOcclusionQuery_Vtbl;
 442             query->extendedData = HeapAlloc(GetProcessHeap(), 0, sizeof(struct wined3d_occlusion_query));
 443             if (!query->extendedData)
 444             {
 445                 ERR("Failed to allocate occlusion query extended data.\n");
 446                 return E_OUTOFMEMORY;
 447             }
 448             ((struct wined3d_occlusion_query *)query->extendedData)->context = NULL;
 449             break;
 450
 451         case WINED3DQUERYTYPE_EVENT:
 452             TRACE("Event query.\n");
 453             if (!gl_info->supported[NV_FENCE] && !gl_info->supported[APPLE_FENCE])
 454             {
 455                 /* Half-Life 2 needs this query. It does not render the main
 456                  * menu correctly otherwise. Pretend to support it, faking
 457                  * this query does not do much harm except potentially
 458                  * lowering performance. */
 459                 FIXME("Event query: Unimplemented, but pretending to be supported.\n");
 460             }
 461             query->lpVtbl = &IWineD3DEventQuery_Vtbl;
 462             query->extendedData = HeapAlloc(GetProcessHeap(), 0, sizeof(struct wined3d_event_query));
 463             if (!query->extendedData)
 464             {
 465                 ERR("Failed to allocate event query extended data.\n");
 466                 return E_OUTOFMEMORY;
 467             }
 468             ((struct wined3d_event_query *)query->extendedData)->context = NULL;
 469             break;
 470
 471         case WINED3DQUERYTYPE_VCACHE:
 472         case WINED3DQUERYTYPE_RESOURCEMANAGER:
 473         case WINED3DQUERYTYPE_VERTEXSTATS:
 474         case WINED3DQUERYTYPE_TIMESTAMP:
 475         case WINED3DQUERYTYPE_TIMESTAMPDISJOINT:
 476         case WINED3DQUERYTYPE_TIMESTAMPFREQ:
 477         case WINED3DQUERYTYPE_PIPELINETIMINGS:
 478         case WINED3DQUERYTYPE_INTERFACETIMINGS:
 479         case WINED3DQUERYTYPE_VERTEXTIMINGS:
 480         case WINED3DQUERYTYPE_PIXELTIMINGS:
 481         case WINED3DQUERYTYPE_BANDWIDTHTIMINGS:
 482         case WINED3DQUERYTYPE_CACHEUTILIZATION:
 483         default:
 484             FIXME("Unhandled query type %#x.\n", type);
 485             return WINED3DERR_NOTAVAILABLE;
 486     }
 487
 488     query->type = type;
 489     query->state = QUERY_CREATED;
 490     query->device = device;
 491     query->parent = parent;
 492     query->ref = 1;
 493
 494     return WINED3D_OK;
 495 }