2 * Mesa 3-D graphics library
4 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the "Software"),
8 * to deal in the Software without restriction, including without limitation
9 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
10 * and/or sell copies of the Software, and to permit persons to whom the
11 * Software is furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included
14 * in all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
17 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
20 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
21 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
22 * OTHER DEALINGS IN THE SOFTWARE.
33 #include "main/dispatch.h"
37 * Allocate a new query object. This is a fallback routine called via
38 * ctx->Driver.NewQueryObject().
39 * \param ctx - rendering context
40 * \param id - the new object's ID
41 * \return pointer to new query_object object or NULL if out of memory.
43 static struct gl_query_object
*
44 _mesa_new_query_object(struct gl_context
*ctx
, GLuint id
)
46 struct gl_query_object
*q
= CALLOC_STRUCT(gl_query_object
);
53 /* This is to satisfy the language of the specification: "In the initial
54 * state of a query object, the result is available" (OpenGL 3.1 §
59 /* OpenGL 3.1 § 2.13 says about GenQueries, "These names are marked as
60 * used, but no object is associated with them until the first time they
61 * are used by BeginQuery." Since our implementation actually does
62 * allocate an object at this point, use a flag to indicate that this
63 * object has not yet been bound so should not be considered a query.
65 q
->EverBound
= GL_FALSE
;
72 * Begin a query. Software driver fallback.
73 * Called via ctx->Driver.BeginQuery().
76 _mesa_begin_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
78 ctx
->NewState
|= _NEW_DEPTH
; /* for swrast */
83 * End a query. Software driver fallback.
84 * Called via ctx->Driver.EndQuery().
87 _mesa_end_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
89 ctx
->NewState
|= _NEW_DEPTH
; /* for swrast */
95 * Wait for query to complete. Software driver fallback.
96 * Called via ctx->Driver.WaitQuery().
99 _mesa_wait_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
101 /* For software drivers, _mesa_end_query() should have completed the query.
102 * For real hardware, implement a proper WaitQuery() driver function,
103 * which may require issuing a flush.
110 * Check if a query results are ready. Software driver fallback.
111 * Called via ctx->Driver.CheckQuery().
114 _mesa_check_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
116 /* No-op for sw rendering.
117 * HW drivers may need to flush at this time.
123 * Delete a query object. Called via ctx->Driver.DeleteQuery().
124 * Not removed from hash table here.
127 _mesa_delete_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
135 _mesa_init_query_object_functions(struct dd_function_table
*driver
)
137 driver
->NewQueryObject
= _mesa_new_query_object
;
138 driver
->DeleteQuery
= _mesa_delete_query
;
139 driver
->BeginQuery
= _mesa_begin_query
;
140 driver
->EndQuery
= _mesa_end_query
;
141 driver
->WaitQuery
= _mesa_wait_query
;
142 driver
->CheckQuery
= _mesa_check_query
;
147 * Return pointer to the query object binding point for the given target.
148 * \return NULL if invalid target, else the address of binding point
150 static struct gl_query_object
**
151 get_query_binding_point(struct gl_context
*ctx
, GLenum target
)
154 case GL_SAMPLES_PASSED_ARB
:
155 if (ctx
->Extensions
.ARB_occlusion_query
)
156 return &ctx
->Query
.CurrentOcclusionObject
;
159 case GL_ANY_SAMPLES_PASSED
:
160 if (ctx
->Extensions
.ARB_occlusion_query2
)
161 return &ctx
->Query
.CurrentOcclusionObject
;
164 case GL_ANY_SAMPLES_PASSED_CONSERVATIVE
:
165 if (ctx
->Extensions
.ARB_ES3_compatibility
166 || (ctx
->API
== API_OPENGLES2
&& ctx
->Version
>= 30))
167 return &ctx
->Query
.CurrentOcclusionObject
;
170 case GL_TIME_ELAPSED_EXT
:
171 if (ctx
->Extensions
.EXT_timer_query
)
172 return &ctx
->Query
.CurrentTimerObject
;
175 case GL_PRIMITIVES_GENERATED
:
176 if (ctx
->Extensions
.EXT_transform_feedback
)
177 return &ctx
->Query
.PrimitivesGenerated
;
180 case GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
:
181 if (ctx
->Extensions
.EXT_transform_feedback
)
182 return &ctx
->Query
.PrimitivesWritten
;
192 _mesa_GenQueries(GLsizei n
, GLuint
*ids
)
195 GET_CURRENT_CONTEXT(ctx
);
197 if (MESA_VERBOSE
& VERBOSE_API
)
198 _mesa_debug(ctx
, "glGenQueries(%d)\n", n
);
201 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGenQueriesARB(n < 0)");
205 first
= _mesa_HashFindFreeKeyBlock(ctx
->Query
.QueryObjects
, n
);
208 for (i
= 0; i
< n
; i
++) {
209 struct gl_query_object
*q
210 = ctx
->Driver
.NewQueryObject(ctx
, first
+ i
);
212 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glGenQueriesARB");
216 _mesa_HashInsert(ctx
->Query
.QueryObjects
, first
+ i
, q
);
223 _mesa_DeleteQueries(GLsizei n
, const GLuint
*ids
)
226 GET_CURRENT_CONTEXT(ctx
);
227 FLUSH_VERTICES(ctx
, 0);
229 if (MESA_VERBOSE
& VERBOSE_API
)
230 _mesa_debug(ctx
, "glDeleteQueries(%d)\n", n
);
233 _mesa_error(ctx
, GL_INVALID_VALUE
, "glDeleteQueriesARB(n < 0)");
237 for (i
= 0; i
< n
; i
++) {
239 struct gl_query_object
*q
= _mesa_lookup_query_object(ctx
, ids
[i
]);
242 struct gl_query_object
**bindpt
;
243 bindpt
= get_query_binding_point(ctx
, q
->Target
);
244 assert(bindpt
); /* Should be non-null for active q. */
248 q
->Active
= GL_FALSE
;
249 ctx
->Driver
.EndQuery(ctx
, q
);
251 _mesa_HashRemove(ctx
->Query
.QueryObjects
, ids
[i
]);
252 ctx
->Driver
.DeleteQuery(ctx
, q
);
260 _mesa_IsQuery(GLuint id
)
262 struct gl_query_object
*q
;
264 GET_CURRENT_CONTEXT(ctx
);
265 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
267 if (MESA_VERBOSE
& VERBOSE_API
)
268 _mesa_debug(ctx
, "glIsQuery(%u)\n", id
);
273 q
= _mesa_lookup_query_object(ctx
, id
);
281 query_error_check_index(struct gl_context
*ctx
, GLenum target
, GLuint index
)
284 case GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
:
285 case GL_PRIMITIVES_GENERATED
:
286 if (index
>= ctx
->Const
.MaxVertexStreams
) {
287 _mesa_error(ctx
, GL_INVALID_VALUE
,
288 "glBeginQueryIndexed(index>=MaxVertexStreams)");
294 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBeginQueryIndexed(index>0)");
302 _mesa_BeginQueryIndexed(GLenum target
, GLuint index
, GLuint id
)
304 struct gl_query_object
*q
, **bindpt
;
305 GET_CURRENT_CONTEXT(ctx
);
307 if (MESA_VERBOSE
& VERBOSE_API
)
308 _mesa_debug(ctx
, "glBeginQueryIndexed(%s, %u, %u)\n",
309 _mesa_lookup_enum_by_nr(target
), index
, id
);
311 if (!query_error_check_index(ctx
, target
, index
))
314 FLUSH_VERTICES(ctx
, 0);
316 bindpt
= get_query_binding_point(ctx
, target
);
318 _mesa_error(ctx
, GL_INVALID_ENUM
, "glBeginQuery{Indexed}(target)");
322 /* From the GL_ARB_occlusion_query spec:
324 * "If BeginQueryARB is called while another query is already in
325 * progress with the same target, an INVALID_OPERATION error is
329 _mesa_error(ctx
, GL_INVALID_OPERATION
,
330 "glBeginQuery{Indexed}(target=%s is active)",
331 _mesa_lookup_enum_by_nr(target
));
336 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glBeginQuery{Indexed}(id==0)");
340 q
= _mesa_lookup_query_object(ctx
, id
);
342 if (ctx
->API
!= API_OPENGL_COMPAT
) {
343 _mesa_error(ctx
, GL_INVALID_OPERATION
,
344 "glBeginQuery{Indexed}(non-gen name)");
347 /* create new object */
348 q
= ctx
->Driver
.NewQueryObject(ctx
, id
);
350 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBeginQuery{Indexed}");
353 _mesa_HashInsert(ctx
->Query
.QueryObjects
, id
, q
);
357 /* pre-existing object */
359 _mesa_error(ctx
, GL_INVALID_OPERATION
,
360 "glBeginQuery{Indexed}(query already active)");
369 q
->EverBound
= GL_TRUE
;
371 /* XXX should probably refcount query objects */
374 ctx
->Driver
.BeginQuery(ctx
, q
);
379 _mesa_EndQueryIndexed(GLenum target
, GLuint index
)
381 struct gl_query_object
*q
, **bindpt
;
382 GET_CURRENT_CONTEXT(ctx
);
384 if (MESA_VERBOSE
& VERBOSE_API
)
385 _mesa_debug(ctx
, "glEndQueryIndexed(%s, %u)\n",
386 _mesa_lookup_enum_by_nr(target
), index
);
388 if (!query_error_check_index(ctx
, target
, index
))
391 FLUSH_VERTICES(ctx
, 0);
393 bindpt
= get_query_binding_point(ctx
, target
);
395 _mesa_error(ctx
, GL_INVALID_ENUM
, "glEndQuery{Indexed}(target)");
399 /* XXX should probably refcount query objects */
402 /* Check for GL_ANY_SAMPLES_PASSED vs GL_SAMPLES_PASSED. */
403 if (q
&& q
->Target
!= target
) {
404 _mesa_error(ctx
, GL_INVALID_OPERATION
,
405 "glEndQuery(target=%s with active query of target %s)",
406 _mesa_lookup_enum_by_nr(target
),
407 _mesa_lookup_enum_by_nr(q
->Target
));
413 if (!q
|| !q
->Active
) {
414 _mesa_error(ctx
, GL_INVALID_OPERATION
,
415 "glEndQuery{Indexed}(no matching glBeginQuery{Indexed})");
419 q
->Active
= GL_FALSE
;
420 ctx
->Driver
.EndQuery(ctx
, q
);
424 _mesa_BeginQuery(GLenum target
, GLuint id
)
426 _mesa_BeginQueryIndexed(target
, 0, id
);
430 _mesa_EndQuery(GLenum target
)
432 _mesa_EndQueryIndexed(target
, 0);
436 _mesa_QueryCounter(GLuint id
, GLenum target
)
438 struct gl_query_object
*q
;
439 GET_CURRENT_CONTEXT(ctx
);
441 if (MESA_VERBOSE
& VERBOSE_API
)
442 _mesa_debug(ctx
, "glQueryCounter(%u, %s)\n", id
,
443 _mesa_lookup_enum_by_nr(target
));
446 if (target
!= GL_TIMESTAMP
) {
447 _mesa_error(ctx
, GL_INVALID_ENUM
, "glQueryCounter(target)");
452 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glQueryCounter(id==0)");
456 q
= _mesa_lookup_query_object(ctx
, id
);
458 /* XXX the Core profile should throw INVALID_OPERATION here */
460 /* create new object */
461 q
= ctx
->Driver
.NewQueryObject(ctx
, id
);
463 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glQueryCounter");
466 _mesa_HashInsert(ctx
->Query
.QueryObjects
, id
, q
);
469 if (q
->Target
&& q
->Target
!= GL_TIMESTAMP
) {
470 _mesa_error(ctx
, GL_INVALID_OPERATION
,
471 "glQueryCounter(id has an invalid target)");
477 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glQueryCounter(id is active)");
484 q
->EverBound
= GL_TRUE
;
486 if (ctx
->Driver
.QueryCounter
) {
487 ctx
->Driver
.QueryCounter(ctx
, q
);
489 /* QueryCounter is implemented using EndQuery without BeginQuery
490 * in drivers. This is actually Direct3D and Gallium convention.
492 ctx
->Driver
.EndQuery(ctx
, q
);
498 _mesa_GetQueryIndexediv(GLenum target
, GLuint index
, GLenum pname
,
501 struct gl_query_object
*q
= NULL
, **bindpt
= NULL
;
502 GET_CURRENT_CONTEXT(ctx
);
504 if (MESA_VERBOSE
& VERBOSE_API
)
505 _mesa_debug(ctx
, "glGetQueryIndexediv(%s, %u, %s)\n",
506 _mesa_lookup_enum_by_nr(target
),
508 _mesa_lookup_enum_by_nr(pname
));
510 if (!query_error_check_index(ctx
, target
, index
))
513 if (target
== GL_TIMESTAMP
) {
514 if (!ctx
->Extensions
.ARB_timer_query
) {
515 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryARB(target)");
520 bindpt
= get_query_binding_point(ctx
, target
);
522 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQuery{Indexed}iv(target)");
530 case GL_QUERY_COUNTER_BITS_ARB
:
532 case GL_SAMPLES_PASSED
:
533 *params
= ctx
->Const
.QueryCounterBits
.SamplesPassed
;
535 case GL_ANY_SAMPLES_PASSED
:
536 /* The minimum value of this is 1 if it's nonzero, and the value
537 * is only ever GL_TRUE or GL_FALSE, so no sense in reporting more
542 case GL_TIME_ELAPSED
:
543 *params
= ctx
->Const
.QueryCounterBits
.TimeElapsed
;
546 *params
= ctx
->Const
.QueryCounterBits
.Timestamp
;
548 case GL_PRIMITIVES_GENERATED
:
549 *params
= ctx
->Const
.QueryCounterBits
.PrimitivesGenerated
;
551 case GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
:
552 *params
= ctx
->Const
.QueryCounterBits
.PrimitivesWritten
;
556 "Unknown target in glGetQueryIndexediv(target = %s)",
557 _mesa_lookup_enum_by_nr(target
));
562 case GL_CURRENT_QUERY_ARB
:
563 *params
= (q
&& q
->Target
== target
) ? q
->Id
: 0;
566 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQuery{Indexed}iv(pname)");
572 _mesa_GetQueryiv(GLenum target
, GLenum pname
, GLint
*params
)
574 _mesa_GetQueryIndexediv(target
, 0, pname
, params
);
578 _mesa_GetQueryObjectiv(GLuint id
, GLenum pname
, GLint
*params
)
580 struct gl_query_object
*q
= NULL
;
581 GET_CURRENT_CONTEXT(ctx
);
583 if (MESA_VERBOSE
& VERBOSE_API
)
584 _mesa_debug(ctx
, "glGetQueryObjectiv(%u, %s)\n", id
,
585 _mesa_lookup_enum_by_nr(pname
));
588 q
= _mesa_lookup_query_object(ctx
, id
);
590 if (!q
|| q
->Active
) {
591 _mesa_error(ctx
, GL_INVALID_OPERATION
,
592 "glGetQueryObjectivARB(id=%d is invalid or active)", id
);
597 case GL_QUERY_RESULT_ARB
:
599 ctx
->Driver
.WaitQuery(ctx
, q
);
600 /* if result is too large for returned type, clamp to max value */
601 if (q
->Target
== GL_ANY_SAMPLES_PASSED
602 || q
->Target
== GL_ANY_SAMPLES_PASSED_CONSERVATIVE
) {
608 if (q
->Result
> 0x7fffffff) {
609 *params
= 0x7fffffff;
612 *params
= (GLint
)q
->Result
;
616 case GL_QUERY_RESULT_AVAILABLE_ARB
:
618 ctx
->Driver
.CheckQuery( ctx
, q
);
622 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjectivARB(pname)");
629 _mesa_GetQueryObjectuiv(GLuint id
, GLenum pname
, GLuint
*params
)
631 struct gl_query_object
*q
= NULL
;
632 GET_CURRENT_CONTEXT(ctx
);
634 if (MESA_VERBOSE
& VERBOSE_API
)
635 _mesa_debug(ctx
, "glGetQueryObjectuiv(%u, %s)\n", id
,
636 _mesa_lookup_enum_by_nr(pname
));
639 q
= _mesa_lookup_query_object(ctx
, id
);
641 if (!q
|| q
->Active
) {
642 _mesa_error(ctx
, GL_INVALID_OPERATION
,
643 "glGetQueryObjectuivARB(id=%d is invalid or active)", id
);
648 case GL_QUERY_RESULT_ARB
:
650 ctx
->Driver
.WaitQuery(ctx
, q
);
651 /* if result is too large for returned type, clamp to max value */
652 if (q
->Target
== GL_ANY_SAMPLES_PASSED
653 || q
->Target
== GL_ANY_SAMPLES_PASSED_CONSERVATIVE
) {
659 if (q
->Result
> 0xffffffff) {
660 *params
= 0xffffffff;
663 *params
= (GLuint
)q
->Result
;
667 case GL_QUERY_RESULT_AVAILABLE_ARB
:
669 ctx
->Driver
.CheckQuery( ctx
, q
);
673 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjectuivARB(pname)");
680 * New with GL_EXT_timer_query
683 _mesa_GetQueryObjecti64v(GLuint id
, GLenum pname
, GLint64EXT
*params
)
685 struct gl_query_object
*q
= NULL
;
686 GET_CURRENT_CONTEXT(ctx
);
688 if (MESA_VERBOSE
& VERBOSE_API
)
689 _mesa_debug(ctx
, "glGetQueryObjecti64v(%u, %s)\n", id
,
690 _mesa_lookup_enum_by_nr(pname
));
693 q
= _mesa_lookup_query_object(ctx
, id
);
695 if (!q
|| q
->Active
) {
696 _mesa_error(ctx
, GL_INVALID_OPERATION
,
697 "glGetQueryObjectui64vARB(id=%d is invalid or active)", id
);
702 case GL_QUERY_RESULT_ARB
:
704 ctx
->Driver
.WaitQuery(ctx
, q
);
707 case GL_QUERY_RESULT_AVAILABLE_ARB
:
709 ctx
->Driver
.CheckQuery( ctx
, q
);
713 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjecti64vARB(pname)");
720 * New with GL_EXT_timer_query
723 _mesa_GetQueryObjectui64v(GLuint id
, GLenum pname
, GLuint64EXT
*params
)
725 struct gl_query_object
*q
= NULL
;
726 GET_CURRENT_CONTEXT(ctx
);
728 if (MESA_VERBOSE
& VERBOSE_API
)
729 _mesa_debug(ctx
, "glGetQueryObjectui64v(%u, %s)\n", id
,
730 _mesa_lookup_enum_by_nr(pname
));
733 q
= _mesa_lookup_query_object(ctx
, id
);
735 if (!q
|| q
->Active
) {
736 _mesa_error(ctx
, GL_INVALID_OPERATION
,
737 "glGetQueryObjectuui64vARB(id=%d is invalid or active)", id
);
742 case GL_QUERY_RESULT_ARB
:
744 ctx
->Driver
.WaitQuery(ctx
, q
);
747 case GL_QUERY_RESULT_AVAILABLE_ARB
:
749 ctx
->Driver
.CheckQuery( ctx
, q
);
753 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjectui64vARB(pname)");
759 * Allocate/init the context state related to query objects.
762 _mesa_init_queryobj(struct gl_context
*ctx
)
764 ctx
->Query
.QueryObjects
= _mesa_NewHashTable();
765 ctx
->Query
.CurrentOcclusionObject
= NULL
;
767 ctx
->Const
.QueryCounterBits
.SamplesPassed
= 64;
768 ctx
->Const
.QueryCounterBits
.TimeElapsed
= 64;
769 ctx
->Const
.QueryCounterBits
.Timestamp
= 64;
770 ctx
->Const
.QueryCounterBits
.PrimitivesGenerated
= 64;
771 ctx
->Const
.QueryCounterBits
.PrimitivesWritten
= 64;
776 * Callback for deleting a query object. Called by _mesa_HashDeleteAll().
779 delete_queryobj_cb(GLuint id
, void *data
, void *userData
)
781 struct gl_query_object
*q
= (struct gl_query_object
*) data
;
782 struct gl_context
*ctx
= (struct gl_context
*)userData
;
783 ctx
->Driver
.DeleteQuery(ctx
, q
);
788 * Free the context state related to query objects.
791 _mesa_free_queryobj_data(struct gl_context
*ctx
)
793 _mesa_HashDeleteAll(ctx
->Query
.QueryObjects
, delete_queryobj_cb
, ctx
);
794 _mesa_DeleteHashTable(ctx
->Query
.QueryObjects
);