query.c 19.5 KB
Newer Older
1 2
/*
 * Copyright 2005 Oliver Stieber
3
 * Copyright 2007-2008 Stefan Dösinger for CodeWeavers
4
 * Copyright 2009-2010 Henri Verbeet for CodeWeavers.
5 6 7 8 9 10 11 12 13 14 15 16 17
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
19 20 21 22
 */


#include "config.h"
23
#include "wine/port.h"
24 25
#include "wined3d_private.h"

26 27
WINE_DEFAULT_DEBUG_CHANNEL(d3d);

28
BOOL wined3d_event_query_supported(const struct wined3d_gl_info *gl_info)
29
{
30
    return gl_info->supported[ARB_SYNC] || gl_info->supported[NV_FENCE] || gl_info->supported[APPLE_FENCE];
31 32
}

33
void wined3d_event_query_destroy(struct wined3d_event_query *query)
34 35 36 37 38
{
    if (query->context) context_free_event_query(query);
    HeapFree(GetProcessHeap(), 0, query);
}

39
static enum wined3d_event_query_result wined3d_event_query_test(const struct wined3d_event_query *query,
40
        const struct wined3d_device *device)
41 42 43 44 45 46 47 48
{
    struct wined3d_context *context;
    const struct wined3d_gl_info *gl_info;
    enum wined3d_event_query_result ret;
    BOOL fence_result;

    TRACE("(%p) : device %p\n", query, device);

49
    if (!query->context)
50 51 52 53 54 55 56 57 58 59 60
    {
        TRACE("Query not started\n");
        return WINED3D_EVENT_QUERY_NOT_STARTED;
    }

    if (!query->context->gl_info->supported[ARB_SYNC] && query->context->tid != GetCurrentThreadId())
    {
        WARN("Event query tested from wrong thread\n");
        return WINED3D_EVENT_QUERY_WRONG_THREAD;
    }

61
    context = context_acquire(device, query->context->current_rt);
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
    gl_info = context->gl_info;

    if (gl_info->supported[ARB_SYNC])
    {
        GLenum gl_ret = GL_EXTCALL(glClientWaitSync(query->object.sync, 0, 0));
        checkGLcall("glClientWaitSync");

        switch (gl_ret)
        {
            case GL_ALREADY_SIGNALED:
            case GL_CONDITION_SATISFIED:
                ret = WINED3D_EVENT_QUERY_OK;
                break;

            case GL_TIMEOUT_EXPIRED:
                ret = WINED3D_EVENT_QUERY_WAITING;
                break;

            case GL_WAIT_FAILED:
            default:
                ERR("glClientWaitSync returned %#x.\n", gl_ret);
                ret = WINED3D_EVENT_QUERY_ERROR;
        }
    }
    else if (gl_info->supported[APPLE_FENCE])
    {
        fence_result = GL_EXTCALL(glTestFenceAPPLE(query->object.id));
        checkGLcall("glTestFenceAPPLE");
        if (fence_result) ret = WINED3D_EVENT_QUERY_OK;
        else ret = WINED3D_EVENT_QUERY_WAITING;
    }
    else if (gl_info->supported[NV_FENCE])
    {
        fence_result = GL_EXTCALL(glTestFenceNV(query->object.id));
        checkGLcall("glTestFenceNV");
        if (fence_result) ret = WINED3D_EVENT_QUERY_OK;
        else ret = WINED3D_EVENT_QUERY_WAITING;
    }
    else
    {
102 103
        ERR("Event query created despite lack of GL support\n");
        ret = WINED3D_EVENT_QUERY_ERROR;
104 105 106 107 108 109
    }

    context_release(context);
    return ret;
}

110
enum wined3d_event_query_result wined3d_event_query_finish(const struct wined3d_event_query *query,
111
        const struct wined3d_device *device)
112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
{
    struct wined3d_context *context;
    const struct wined3d_gl_info *gl_info;
    enum wined3d_event_query_result ret;

    TRACE("(%p)\n", query);

    if (!query->context)
    {
        TRACE("Query not started\n");
        return WINED3D_EVENT_QUERY_NOT_STARTED;
    }
    gl_info = query->context->gl_info;

    if (query->context->tid != GetCurrentThreadId() && !gl_info->supported[ARB_SYNC])
    {
        /* A glFinish does not reliably wait for draws in other contexts. The caller has
         * to find its own way to cope with the thread switch
         */
        WARN("Event query finished from wrong thread\n");
        return WINED3D_EVENT_QUERY_WRONG_THREAD;
    }

135
    context = context_acquire(device, query->context->current_rt);
136 137 138

    if (gl_info->supported[ARB_SYNC])
    {
139 140 141 142
        /* Apple seems to be into arbitrary limits, and timeouts larger than
         * 0xfffffffffffffbff immediately return GL_TIMEOUT_EXPIRED. We don't
         * really care and can live with waiting a few μs less. (OS X 10.7.4). */
        GLenum gl_ret = GL_EXTCALL(glClientWaitSync(query->object.sync, GL_SYNC_FLUSH_COMMANDS_BIT, ~(GLuint64)0xffff));
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
        checkGLcall("glClientWaitSync");

        switch (gl_ret)
        {
            case GL_ALREADY_SIGNALED:
            case GL_CONDITION_SATISFIED:
                ret = WINED3D_EVENT_QUERY_OK;
                break;

                /* We don't expect a timeout for a ~584 year wait */
            default:
                ERR("glClientWaitSync returned %#x.\n", gl_ret);
                ret = WINED3D_EVENT_QUERY_ERROR;
        }
    }
    else if (context->gl_info->supported[APPLE_FENCE])
    {
        GL_EXTCALL(glFinishFenceAPPLE(query->object.id));
        checkGLcall("glFinishFenceAPPLE");
        ret = WINED3D_EVENT_QUERY_OK;
    }
    else if (context->gl_info->supported[NV_FENCE])
    {
        GL_EXTCALL(glFinishFenceNV(query->object.id));
        checkGLcall("glFinishFenceNV");
        ret = WINED3D_EVENT_QUERY_OK;
    }
    else
    {
        ERR("Event query created without GL support\n");
        ret = WINED3D_EVENT_QUERY_ERROR;
    }

    context_release(context);
    return ret;
}

180
void wined3d_event_query_issue(struct wined3d_event_query *query, const struct wined3d_device *device)
181 182 183 184 185 186 187 188 189
{
    const struct wined3d_gl_info *gl_info;
    struct wined3d_context *context;

    if (query->context)
    {
        if (!query->context->gl_info->supported[ARB_SYNC] && query->context->tid != GetCurrentThreadId())
        {
            context_free_event_query(query);
190
            context = context_acquire(device, NULL);
191 192 193 194
            context_alloc_event_query(context, query);
        }
        else
        {
195
            context = context_acquire(device, query->context->current_rt);
196 197 198 199
        }
    }
    else
    {
200
        context = context_acquire(device, NULL);
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
        context_alloc_event_query(context, query);
    }

    gl_info = context->gl_info;

    if (gl_info->supported[ARB_SYNC])
    {
        if (query->object.sync) GL_EXTCALL(glDeleteSync(query->object.sync));
        checkGLcall("glDeleteSync");
        query->object.sync = GL_EXTCALL(glFenceSync(GL_SYNC_GPU_COMMANDS_COMPLETE, 0));
        checkGLcall("glFenceSync");
    }
    else if (gl_info->supported[APPLE_FENCE])
    {
        GL_EXTCALL(glSetFenceAPPLE(query->object.id));
        checkGLcall("glSetFenceAPPLE");
    }
    else if (gl_info->supported[NV_FENCE])
    {
        GL_EXTCALL(glSetFenceNV(query->object.id, GL_ALL_COMPLETED_NV));
        checkGLcall("glSetFenceNV");
    }

    context_release(context);
}

227
ULONG CDECL wined3d_query_incref(struct wined3d_query *query)
228
{
229
    ULONG refcount = InterlockedIncrement(&query->ref);
230

231
    TRACE("%p increasing refcount to %u.\n", query, refcount);
232

233
    return refcount;
234 235
}

236 237
ULONG CDECL wined3d_query_decref(struct wined3d_query *query)
{
238
    ULONG refcount = InterlockedDecrement(&query->ref);
239

240
    TRACE("%p decreasing refcount to %u.\n", query, refcount);
241

242
    if (!refcount)
243
    {
244 245 246 247
        /* Queries are specific to the GL context that created them. Not
         * deleting the query will obviously leak it, but that's still better
         * than potentially deleting a different query with the same id in this
         * context, and (still) leaking the actual query. */
248
        if (query->type == WINED3D_QUERY_TYPE_EVENT)
249
        {
250 251
            struct wined3d_event_query *event_query = query->extendedData;
            if (event_query) wined3d_event_query_destroy(event_query);
252
        }
253
        else if (query->type == WINED3D_QUERY_TYPE_OCCLUSION)
254
        {
255
            struct wined3d_occlusion_query *oq = query->extendedData;
256

257 258
            if (oq->context) context_free_occlusion_query(oq);
            HeapFree(GetProcessHeap(), 0, query->extendedData);
259 260
        }

261
        HeapFree(GetProcessHeap(), 0, query);
262
    }
263 264

    return refcount;
265 266
}

267 268
HRESULT CDECL wined3d_query_get_data(struct wined3d_query *query,
        void *data, UINT data_size, DWORD flags)
269
{
270 271
    TRACE("query %p, data %p, data_size %u, flags %#x.\n",
            query, data, data_size, flags);
272 273 274 275

    return query->query_ops->query_get_data(query, data, data_size, flags);
}

276
UINT CDECL wined3d_query_get_data_size(const struct wined3d_query *query)
277
{
278
    TRACE("query %p.\n", query);
279 280 281 282

    return query->data_size;
}

283
HRESULT CDECL wined3d_query_issue(struct wined3d_query *query, DWORD flags)
284
{
285
    TRACE("query %p, flags %#x.\n", query, flags);
286 287 288 289

    return query->query_ops->query_issue(query, flags);
}

290
static HRESULT wined3d_occlusion_query_ops_get_data(struct wined3d_query *query,
291 292
        void *pData, DWORD dwSize, DWORD flags)
{
293
    struct wined3d_occlusion_query *oq = query->extendedData;
294
    struct wined3d_device *device = query->device;
295
    const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
296
    struct wined3d_context *context;
297
    DWORD* data = pData;
298 299
    GLuint available;
    GLuint samples;
300
    HRESULT res;
301

302
    TRACE("(%p) : type D3DQUERY_OCCLUSION, pData %p, dwSize %#x, flags %#x.\n", query, pData, dwSize, flags);
303

304 305
    if (!oq->context)
        query->state = QUERY_CREATED;
306

307
    if (query->state == QUERY_CREATED)
308
    {
309 310 311
        /* D3D allows GetData on a new query, OpenGL doesn't. So just invent the data ourselves */
        TRACE("Query wasn't yet started, returning S_OK\n");
        if(data) *data = 0;
312 313 314
        return S_OK;
    }

315
    if (query->state == QUERY_BUILDING)
316
    {
317 318
        /* Msdn says this returns an error, but our tests show that S_FALSE is returned */
        TRACE("Query is building, returning S_FALSE\n");
319
        return S_FALSE;
320
    }
321

322
    if (!gl_info->supported[ARB_OCCLUSION_QUERY])
323
    {
324
        WARN("%p Occlusion queries not supported. Returning 1.\n", query);
325
        *data = 1;
326 327 328
        return S_OK;
    }

329
    if (oq->context->tid != GetCurrentThreadId())
330
    {
331
        FIXME("%p Wrong thread, returning 1.\n", query);
332 333 334 335
        *data = 1;
        return S_OK;
    }

336
    context = context_acquire(query->device, oq->context->current_rt);
337

338
    GL_EXTCALL(glGetQueryObjectuivARB(oq->id, GL_QUERY_RESULT_AVAILABLE_ARB, &available));
339
    checkGLcall("glGetQueryObjectuivARB(GL_QUERY_RESULT_AVAILABLE)");
340
    TRACE("available %#x.\n", available);
341 342 343 344 345

    if (available)
    {
        if (data)
        {
346
            GL_EXTCALL(glGetQueryObjectuivARB(oq->id, GL_QUERY_RESULT_ARB, &samples));
347
            checkGLcall("glGetQueryObjectuivARB(GL_QUERY_RESULT)");
348
            TRACE("Returning %d samples.\n", samples);
349 350
            *data = samples;
        }
351 352
        res = S_OK;
    }
353 354 355 356 357
    else
    {
        res = S_FALSE;
    }

358 359
    context_release(context);

360 361 362
    return res;
}

363
static HRESULT wined3d_event_query_ops_get_data(struct wined3d_query *query,
364 365
        void *pData, DWORD dwSize, DWORD flags)
{
366
    struct wined3d_event_query *event_query = query->extendedData;
367
    BOOL *data = pData;
368
    enum wined3d_event_query_result ret;
369

370
    TRACE("query %p, pData %p, dwSize %#x, flags %#x.\n", query, pData, dwSize, flags);
371

372
    if (!pData || !dwSize) return S_OK;
373
    if (!event_query)
374
    {
375
        WARN("Event query not supported by GL, reporting GPU idle.\n");
376 377 378
        *data = TRUE;
        return S_OK;
    }
379

380
    ret = wined3d_event_query_test(event_query, query->device);
381
    switch(ret)
382
    {
383 384 385 386 387 388 389 390 391 392
        case WINED3D_EVENT_QUERY_OK:
        case WINED3D_EVENT_QUERY_NOT_STARTED:
            *data = TRUE;
            break;

        case WINED3D_EVENT_QUERY_WAITING:
            *data = FALSE;
            break;

        case WINED3D_EVENT_QUERY_WRONG_THREAD:
393
            FIXME("(%p) Wrong thread, reporting GPU idle.\n", query);
394 395 396 397 398 399
            *data = TRUE;
            break;

        case WINED3D_EVENT_QUERY_ERROR:
            ERR("The GL event query failed, returning D3DERR_INVALIDCALL\n");
            return WINED3DERR_INVALIDCALL;
400 401
    }

402 403
    return S_OK;
}
404

405
enum wined3d_query_type CDECL wined3d_query_get_type(const struct wined3d_query *query)
406 407 408 409
{
    TRACE("query %p.\n", query);

    return query->type;
410 411
}

412
static HRESULT wined3d_event_query_ops_issue(struct wined3d_query *query, DWORD flags)
413
{
414
    TRACE("query %p, flags %#x.\n", query, flags);
415

416
    TRACE("(%p) : flags %#x, type D3DQUERY_EVENT\n", query, flags);
417
    if (flags & WINED3DISSUE_END)
418
    {
419
        struct wined3d_event_query *event_query = query->extendedData;
420 421

        /* Faked event query support */
422
        if (!event_query) return WINED3D_OK;
423

424
        wined3d_event_query_issue(event_query, query->device);
425
    }
426
    else if (flags & WINED3DISSUE_BEGIN)
427
    {
428 429 430 431
        /* Started implicitly at device creation */
        ERR("Event query issued with START flag - what to do?\n");
    }

432
    if (flags & WINED3DISSUE_BEGIN)
433
        query->state = QUERY_BUILDING;
434
    else
435
        query->state = QUERY_SIGNALLED;
436 437 438 439

    return WINED3D_OK;
}

440
static HRESULT wined3d_occlusion_query_ops_issue(struct wined3d_query *query, DWORD flags)
441
{
442
    struct wined3d_device *device = query->device;
443
    const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;
444

445 446
    TRACE("query %p, flags %#x.\n", query, flags);

447
    if (gl_info->supported[ARB_OCCLUSION_QUERY])
448
    {
449
        struct wined3d_occlusion_query *oq = query->extendedData;
450
        struct wined3d_context *context;
451

452
        /* This is allowed according to msdn and our tests. Reset the query and restart */
453
        if (flags & WINED3DISSUE_BEGIN)
454
        {
455
            if (query->state == QUERY_BUILDING)
456
            {
457
                if (oq->context->tid != GetCurrentThreadId())
458 459
                {
                    FIXME("Wrong thread, can't restart query.\n");
460

461 462 463
                    context_free_occlusion_query(oq);
                    context = context_acquire(query->device, NULL);
                    context_alloc_occlusion_query(context, oq);
464 465 466
                }
                else
                {
467
                    context = context_acquire(query->device, oq->context->current_rt);
468

469 470 471 472
                    GL_EXTCALL(glEndQueryARB(GL_SAMPLES_PASSED_ARB));
                    checkGLcall("glEndQuery()");
                }
            }
473 474
            else
            {
475 476 477
                if (oq->context) context_free_occlusion_query(oq);
                context = context_acquire(query->device, NULL);
                context_alloc_occlusion_query(context, oq);
478 479
            }

480
            GL_EXTCALL(glBeginQueryARB(GL_SAMPLES_PASSED_ARB, oq->id));
481
            checkGLcall("glBeginQuery()");
482 483

            context_release(context);
484
        }
485 486
        if (flags & WINED3DISSUE_END)
        {
487 488 489 490
            /* Msdn says _END on a non-building occlusion query returns an error, but
             * our tests show that it returns OK. But OpenGL doesn't like it, so avoid
             * generating an error
             */
491
            if (query->state == QUERY_BUILDING)
492
            {
493
                if (oq->context->tid != GetCurrentThreadId())
494 495 496 497 498
                {
                    FIXME("Wrong thread, can't end query.\n");
                }
                else
                {
499
                    context = context_acquire(query->device, oq->context->current_rt);
500

501 502
                    GL_EXTCALL(glEndQueryARB(GL_SAMPLES_PASSED_ARB));
                    checkGLcall("glEndQuery()");
503 504

                    context_release(context);
505 506
                }
            }
507
        }
508 509 510 511
    }
    else
    {
        FIXME("%p Occlusion queries not supported.\n", query);
512
    }
513

514
    if (flags & WINED3DISSUE_BEGIN)
515
        query->state = QUERY_BUILDING;
516
    else
517
        query->state = QUERY_SIGNALLED;
518

519 520 521
    return WINED3D_OK; /* can be WINED3DERR_INVALIDCALL.    */
}

522
static const struct wined3d_query_ops event_query_ops =
523
{
524 525 526 527 528 529 530 531
    wined3d_event_query_ops_get_data,
    wined3d_event_query_ops_issue,
};

static const struct wined3d_query_ops occlusion_query_ops =
{
    wined3d_occlusion_query_ops_get_data,
    wined3d_occlusion_query_ops_issue,
532
};
533

534
static HRESULT query_init(struct wined3d_query *query, struct wined3d_device *device, enum wined3d_query_type type)
535 536 537 538 539
{
    const struct wined3d_gl_info *gl_info = &device->adapter->gl_info;

    switch (type)
    {
540
        case WINED3D_QUERY_TYPE_OCCLUSION:
541 542 543
            TRACE("Occlusion query.\n");
            if (!gl_info->supported[ARB_OCCLUSION_QUERY])
            {
544
                WARN("Unsupported in local OpenGL implementation: ARB_OCCLUSION_QUERY.\n");
545 546
                return WINED3DERR_NOTAVAILABLE;
            }
547 548
            query->query_ops = &occlusion_query_ops;
            query->data_size = sizeof(DWORD);
549 550 551 552 553 554 555 556 557
            query->extendedData = HeapAlloc(GetProcessHeap(), 0, sizeof(struct wined3d_occlusion_query));
            if (!query->extendedData)
            {
                ERR("Failed to allocate occlusion query extended data.\n");
                return E_OUTOFMEMORY;
            }
            ((struct wined3d_occlusion_query *)query->extendedData)->context = NULL;
            break;

558
        case WINED3D_QUERY_TYPE_EVENT:
559
            TRACE("Event query.\n");
560
            if (!wined3d_event_query_supported(gl_info))
561 562 563 564 565 566 567
            {
                /* Half-Life 2 needs this query. It does not render the main
                 * menu correctly otherwise. Pretend to support it, faking
                 * this query does not do much harm except potentially
                 * lowering performance. */
                FIXME("Event query: Unimplemented, but pretending to be supported.\n");
            }
568 569
            query->query_ops = &event_query_ops;
            query->data_size = sizeof(BOOL);
570 571
            query->extendedData = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct wined3d_event_query));
            if (!query->extendedData)
572
            {
573 574
                ERR("Failed to allocate event query memory.\n");
                return E_OUTOFMEMORY;
575 576 577
            }
            break;

578 579 580 581 582 583 584 585 586 587 588 589
        case WINED3D_QUERY_TYPE_VCACHE:
        case WINED3D_QUERY_TYPE_RESOURCE_MANAGER:
        case WINED3D_QUERY_TYPE_VERTEX_STATS:
        case WINED3D_QUERY_TYPE_TIMESTAMP:
        case WINED3D_QUERY_TYPE_TIMESTAMP_DISJOINT:
        case WINED3D_QUERY_TYPE_TIMESTAMP_FREQ:
        case WINED3D_QUERY_TYPE_PIPELINE_TIMINGS:
        case WINED3D_QUERY_TYPE_INTERFACE_TIMINGS:
        case WINED3D_QUERY_TYPE_VERTEX_TIMINGS:
        case WINED3D_QUERY_TYPE_PIXEL_TIMINGS:
        case WINED3D_QUERY_TYPE_BANDWIDTH_TIMINGS:
        case WINED3D_QUERY_TYPE_CACHE_UTILIZATION:
590 591 592 593 594 595 596 597 598 599 600 601
        default:
            FIXME("Unhandled query type %#x.\n", type);
            return WINED3DERR_NOTAVAILABLE;
    }

    query->type = type;
    query->state = QUERY_CREATED;
    query->device = device;
    query->ref = 1;

    return WINED3D_OK;
}
602

603
HRESULT CDECL wined3d_query_create(struct wined3d_device *device,
604
        enum wined3d_query_type type, struct wined3d_query **query)
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
{
    struct wined3d_query *object;
    HRESULT hr;

    TRACE("device %p, type %#x, query %p.\n", device, type, query);

    object = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(*object));
    if (!object)
        return E_OUTOFMEMORY;

    hr = query_init(object, device, type);
    if (FAILED(hr))
    {
        WARN("Failed to initialize query, hr %#x.\n", hr);
        HeapFree(GetProcessHeap(), 0, object);
        return hr;
    }

    TRACE("Created query %p.\n", object);
    *query = object;

    return WINED3D_OK;
}