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
= MALLOC_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
)
134 _mesa_init_query_object_functions(struct dd_function_table
*driver
)
136 driver
->NewQueryObject
= _mesa_new_query_object
;
137 driver
->DeleteQuery
= _mesa_delete_query
;
138 driver
->BeginQuery
= _mesa_begin_query
;
139 driver
->EndQuery
= _mesa_end_query
;
140 driver
->WaitQuery
= _mesa_wait_query
;
141 driver
->CheckQuery
= _mesa_check_query
;
146 * Return pointer to the query object binding point for the given target.
147 * \return NULL if invalid target, else the address of binding point
149 static struct gl_query_object
**
150 get_query_binding_point(struct gl_context
*ctx
, GLenum target
)
153 case GL_SAMPLES_PASSED_ARB
:
154 if (ctx
->Extensions
.ARB_occlusion_query
)
155 return &ctx
->Query
.CurrentOcclusionObject
;
158 case GL_ANY_SAMPLES_PASSED
:
159 if (ctx
->Extensions
.ARB_occlusion_query2
)
160 return &ctx
->Query
.CurrentOcclusionObject
;
163 case GL_ANY_SAMPLES_PASSED_CONSERVATIVE
:
164 if (ctx
->Extensions
.ARB_ES3_compatibility
165 || (ctx
->API
== API_OPENGLES2
&& ctx
->Version
>= 30))
166 return &ctx
->Query
.CurrentOcclusionObject
;
169 case GL_TIME_ELAPSED_EXT
:
170 if (ctx
->Extensions
.EXT_timer_query
)
171 return &ctx
->Query
.CurrentTimerObject
;
174 case GL_PRIMITIVES_GENERATED
:
175 if (ctx
->Extensions
.EXT_transform_feedback
)
176 return &ctx
->Query
.PrimitivesGenerated
;
179 case GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
:
180 if (ctx
->Extensions
.EXT_transform_feedback
)
181 return &ctx
->Query
.PrimitivesWritten
;
191 _mesa_GenQueries(GLsizei n
, GLuint
*ids
)
194 GET_CURRENT_CONTEXT(ctx
);
196 if (MESA_VERBOSE
& VERBOSE_API
)
197 _mesa_debug(ctx
, "glGenQueries(%d)\n", n
);
200 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGenQueriesARB(n < 0)");
204 /* No query objects can be active at this time! */
205 if (ctx
->Query
.CurrentOcclusionObject
||
206 ctx
->Query
.CurrentTimerObject
) {
207 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glGenQueriesARB");
211 first
= _mesa_HashFindFreeKeyBlock(ctx
->Query
.QueryObjects
, n
);
214 for (i
= 0; i
< n
; i
++) {
215 struct gl_query_object
*q
216 = ctx
->Driver
.NewQueryObject(ctx
, first
+ i
);
218 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glGenQueriesARB");
222 _mesa_HashInsert(ctx
->Query
.QueryObjects
, first
+ i
, q
);
229 _mesa_DeleteQueries(GLsizei n
, const GLuint
*ids
)
232 GET_CURRENT_CONTEXT(ctx
);
233 FLUSH_VERTICES(ctx
, 0);
235 if (MESA_VERBOSE
& VERBOSE_API
)
236 _mesa_debug(ctx
, "glDeleteQueries(%d)\n", n
);
239 _mesa_error(ctx
, GL_INVALID_VALUE
, "glDeleteQueriesARB(n < 0)");
243 /* No query objects can be active at this time! */
244 if (ctx
->Query
.CurrentOcclusionObject
||
245 ctx
->Query
.CurrentTimerObject
) {
246 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glDeleteQueriesARB");
250 for (i
= 0; i
< n
; i
++) {
252 struct gl_query_object
*q
= _mesa_lookup_query_object(ctx
, ids
[i
]);
254 ASSERT(!q
->Active
); /* should be caught earlier */
255 _mesa_HashRemove(ctx
->Query
.QueryObjects
, ids
[i
]);
256 ctx
->Driver
.DeleteQuery(ctx
, q
);
264 _mesa_IsQuery(GLuint id
)
266 struct gl_query_object
*q
;
268 GET_CURRENT_CONTEXT(ctx
);
269 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
271 if (MESA_VERBOSE
& VERBOSE_API
)
272 _mesa_debug(ctx
, "glIsQuery(%u)\n", id
);
277 q
= _mesa_lookup_query_object(ctx
, id
);
285 query_error_check_index(struct gl_context
*ctx
, GLenum target
, GLuint index
)
288 case GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
:
289 case GL_PRIMITIVES_GENERATED
:
290 if (index
>= ctx
->Const
.MaxVertexStreams
) {
291 _mesa_error(ctx
, GL_INVALID_VALUE
,
292 "glBeginQueryIndexed(index>=MaxVertexStreams)");
298 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBeginQueryIndexed(index>0)");
306 _mesa_BeginQueryIndexed(GLenum target
, GLuint index
, GLuint id
)
308 struct gl_query_object
*q
, **bindpt
;
309 GET_CURRENT_CONTEXT(ctx
);
311 if (MESA_VERBOSE
& VERBOSE_API
)
312 _mesa_debug(ctx
, "glBeginQueryIndexed(%s, %u, %u)\n",
313 _mesa_lookup_enum_by_nr(target
), index
, id
);
315 if (!query_error_check_index(ctx
, target
, index
))
318 FLUSH_VERTICES(ctx
, 0);
320 bindpt
= get_query_binding_point(ctx
, target
);
322 _mesa_error(ctx
, GL_INVALID_ENUM
, "glBeginQuery{Indexed}(target)");
326 /* From the GL_ARB_occlusion_query spec:
328 * "If BeginQueryARB is called while another query is already in
329 * progress with the same target, an INVALID_OPERATION error is
333 _mesa_error(ctx
, GL_INVALID_OPERATION
,
334 "glBeginQuery{Indexed}(target=%s is active)",
335 _mesa_lookup_enum_by_nr(target
));
340 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glBeginQuery{Indexed}(id==0)");
344 q
= _mesa_lookup_query_object(ctx
, id
);
346 if (ctx
->API
!= API_OPENGL_COMPAT
) {
347 _mesa_error(ctx
, GL_INVALID_OPERATION
,
348 "glBeginQuery{Indexed}(non-gen name)");
351 /* create new object */
352 q
= ctx
->Driver
.NewQueryObject(ctx
, id
);
354 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBeginQuery{Indexed}");
357 _mesa_HashInsert(ctx
->Query
.QueryObjects
, id
, q
);
361 /* pre-existing object */
363 _mesa_error(ctx
, GL_INVALID_OPERATION
,
364 "glBeginQuery{Indexed}(query already active)");
373 q
->EverBound
= GL_TRUE
;
375 /* XXX should probably refcount query objects */
378 ctx
->Driver
.BeginQuery(ctx
, q
);
383 _mesa_EndQueryIndexed(GLenum target
, GLuint index
)
385 struct gl_query_object
*q
, **bindpt
;
386 GET_CURRENT_CONTEXT(ctx
);
388 if (MESA_VERBOSE
& VERBOSE_API
)
389 _mesa_debug(ctx
, "glEndQueryIndexed(%s, %u)\n",
390 _mesa_lookup_enum_by_nr(target
), index
);
392 if (!query_error_check_index(ctx
, target
, index
))
395 FLUSH_VERTICES(ctx
, 0);
397 bindpt
= get_query_binding_point(ctx
, target
);
399 _mesa_error(ctx
, GL_INVALID_ENUM
, "glEndQuery{Indexed}(target)");
403 /* XXX should probably refcount query objects */
406 /* Check for GL_ANY_SAMPLES_PASSED vs GL_SAMPLES_PASSED. */
407 if (q
&& q
->Target
!= target
) {
408 _mesa_error(ctx
, GL_INVALID_OPERATION
,
409 "glEndQuery(target=%s with active query of target %s)",
410 _mesa_lookup_enum_by_nr(target
),
411 _mesa_lookup_enum_by_nr(q
->Target
));
417 if (!q
|| !q
->Active
) {
418 _mesa_error(ctx
, GL_INVALID_OPERATION
,
419 "glEndQuery{Indexed}(no matching glBeginQuery{Indexed})");
423 q
->Active
= GL_FALSE
;
424 ctx
->Driver
.EndQuery(ctx
, q
);
428 _mesa_BeginQuery(GLenum target
, GLuint id
)
430 _mesa_BeginQueryIndexed(target
, 0, id
);
434 _mesa_EndQuery(GLenum target
)
436 _mesa_EndQueryIndexed(target
, 0);
440 _mesa_QueryCounter(GLuint id
, GLenum target
)
442 struct gl_query_object
*q
;
443 GET_CURRENT_CONTEXT(ctx
);
445 if (MESA_VERBOSE
& VERBOSE_API
)
446 _mesa_debug(ctx
, "glQueryCounter(%u, %s)\n", id
,
447 _mesa_lookup_enum_by_nr(target
));
450 if (target
!= GL_TIMESTAMP
) {
451 _mesa_error(ctx
, GL_INVALID_ENUM
, "glQueryCounter(target)");
456 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glQueryCounter(id==0)");
460 q
= _mesa_lookup_query_object(ctx
, id
);
462 /* XXX the Core profile should throw INVALID_OPERATION here */
464 /* create new object */
465 q
= ctx
->Driver
.NewQueryObject(ctx
, id
);
467 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glQueryCounter");
470 _mesa_HashInsert(ctx
->Query
.QueryObjects
, id
, q
);
473 if (q
->Target
&& q
->Target
!= GL_TIMESTAMP
) {
474 _mesa_error(ctx
, GL_INVALID_OPERATION
,
475 "glQueryCounter(id has an invalid target)");
481 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glQueryCounter(id is active)");
489 if (ctx
->Driver
.QueryCounter
) {
490 ctx
->Driver
.QueryCounter(ctx
, q
);
492 /* QueryCounter is implemented using EndQuery without BeginQuery
493 * in drivers. This is actually Direct3D and Gallium convention.
495 ctx
->Driver
.EndQuery(ctx
, q
);
501 _mesa_GetQueryIndexediv(GLenum target
, GLuint index
, GLenum pname
,
504 struct gl_query_object
*q
= NULL
, **bindpt
= NULL
;
505 GET_CURRENT_CONTEXT(ctx
);
507 if (MESA_VERBOSE
& VERBOSE_API
)
508 _mesa_debug(ctx
, "glGetQueryIndexediv(%s, %u, %s)\n",
509 _mesa_lookup_enum_by_nr(target
),
511 _mesa_lookup_enum_by_nr(pname
));
513 if (!query_error_check_index(ctx
, target
, index
))
516 if (target
== GL_TIMESTAMP
) {
517 if (!ctx
->Extensions
.ARB_timer_query
) {
518 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryARB(target)");
523 bindpt
= get_query_binding_point(ctx
, target
);
525 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQuery{Indexed}iv(target)");
533 case GL_QUERY_COUNTER_BITS_ARB
:
535 case GL_SAMPLES_PASSED
:
536 *params
= ctx
->Const
.QueryCounterBits
.SamplesPassed
;
538 case GL_ANY_SAMPLES_PASSED
:
539 /* The minimum value of this is 1 if it's nonzero, and the value
540 * is only ever GL_TRUE or GL_FALSE, so no sense in reporting more
545 case GL_TIME_ELAPSED
:
546 *params
= ctx
->Const
.QueryCounterBits
.TimeElapsed
;
549 *params
= ctx
->Const
.QueryCounterBits
.Timestamp
;
551 case GL_PRIMITIVES_GENERATED
:
552 *params
= ctx
->Const
.QueryCounterBits
.PrimitivesGenerated
;
554 case GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
:
555 *params
= ctx
->Const
.QueryCounterBits
.PrimitivesWritten
;
559 "Unknown target in glGetQueryIndexediv(target = %s)",
560 _mesa_lookup_enum_by_nr(target
));
565 case GL_CURRENT_QUERY_ARB
:
566 *params
= (q
&& q
->Target
== target
) ? q
->Id
: 0;
569 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQuery{Indexed}iv(pname)");
575 _mesa_GetQueryiv(GLenum target
, GLenum pname
, GLint
*params
)
577 _mesa_GetQueryIndexediv(target
, 0, pname
, params
);
581 _mesa_GetQueryObjectiv(GLuint id
, GLenum pname
, GLint
*params
)
583 struct gl_query_object
*q
= NULL
;
584 GET_CURRENT_CONTEXT(ctx
);
586 if (MESA_VERBOSE
& VERBOSE_API
)
587 _mesa_debug(ctx
, "glGetQueryObjectiv(%u, %s)\n", id
,
588 _mesa_lookup_enum_by_nr(pname
));
591 q
= _mesa_lookup_query_object(ctx
, id
);
593 if (!q
|| q
->Active
) {
594 _mesa_error(ctx
, GL_INVALID_OPERATION
,
595 "glGetQueryObjectivARB(id=%d is invalid or active)", id
);
600 case GL_QUERY_RESULT_ARB
:
602 ctx
->Driver
.WaitQuery(ctx
, q
);
603 /* if result is too large for returned type, clamp to max value */
604 if (q
->Target
== GL_ANY_SAMPLES_PASSED
605 || q
->Target
== GL_ANY_SAMPLES_PASSED_CONSERVATIVE
) {
611 if (q
->Result
> 0x7fffffff) {
612 *params
= 0x7fffffff;
615 *params
= (GLint
)q
->Result
;
619 case GL_QUERY_RESULT_AVAILABLE_ARB
:
621 ctx
->Driver
.CheckQuery( ctx
, q
);
625 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjectivARB(pname)");
632 _mesa_GetQueryObjectuiv(GLuint id
, GLenum pname
, GLuint
*params
)
634 struct gl_query_object
*q
= NULL
;
635 GET_CURRENT_CONTEXT(ctx
);
637 if (MESA_VERBOSE
& VERBOSE_API
)
638 _mesa_debug(ctx
, "glGetQueryObjectuiv(%u, %s)\n", id
,
639 _mesa_lookup_enum_by_nr(pname
));
642 q
= _mesa_lookup_query_object(ctx
, id
);
644 if (!q
|| q
->Active
) {
645 _mesa_error(ctx
, GL_INVALID_OPERATION
,
646 "glGetQueryObjectuivARB(id=%d is invalid or active)", id
);
651 case GL_QUERY_RESULT_ARB
:
653 ctx
->Driver
.WaitQuery(ctx
, q
);
654 /* if result is too large for returned type, clamp to max value */
655 if (q
->Target
== GL_ANY_SAMPLES_PASSED
656 || q
->Target
== GL_ANY_SAMPLES_PASSED_CONSERVATIVE
) {
662 if (q
->Result
> 0xffffffff) {
663 *params
= 0xffffffff;
666 *params
= (GLuint
)q
->Result
;
670 case GL_QUERY_RESULT_AVAILABLE_ARB
:
672 ctx
->Driver
.CheckQuery( ctx
, q
);
676 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjectuivARB(pname)");
683 * New with GL_EXT_timer_query
686 _mesa_GetQueryObjecti64v(GLuint id
, GLenum pname
, GLint64EXT
*params
)
688 struct gl_query_object
*q
= NULL
;
689 GET_CURRENT_CONTEXT(ctx
);
691 if (MESA_VERBOSE
& VERBOSE_API
)
692 _mesa_debug(ctx
, "glGetQueryObjecti64v(%u, %s)\n", id
,
693 _mesa_lookup_enum_by_nr(pname
));
696 q
= _mesa_lookup_query_object(ctx
, id
);
698 if (!q
|| q
->Active
) {
699 _mesa_error(ctx
, GL_INVALID_OPERATION
,
700 "glGetQueryObjectui64vARB(id=%d is invalid or active)", id
);
705 case GL_QUERY_RESULT_ARB
:
707 ctx
->Driver
.WaitQuery(ctx
, q
);
710 case GL_QUERY_RESULT_AVAILABLE_ARB
:
712 ctx
->Driver
.CheckQuery( ctx
, q
);
716 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjecti64vARB(pname)");
723 * New with GL_EXT_timer_query
726 _mesa_GetQueryObjectui64v(GLuint id
, GLenum pname
, GLuint64EXT
*params
)
728 struct gl_query_object
*q
= NULL
;
729 GET_CURRENT_CONTEXT(ctx
);
731 if (MESA_VERBOSE
& VERBOSE_API
)
732 _mesa_debug(ctx
, "glGetQueryObjectui64v(%u, %s)\n", id
,
733 _mesa_lookup_enum_by_nr(pname
));
736 q
= _mesa_lookup_query_object(ctx
, id
);
738 if (!q
|| q
->Active
) {
739 _mesa_error(ctx
, GL_INVALID_OPERATION
,
740 "glGetQueryObjectuui64vARB(id=%d is invalid or active)", id
);
745 case GL_QUERY_RESULT_ARB
:
747 ctx
->Driver
.WaitQuery(ctx
, q
);
750 case GL_QUERY_RESULT_AVAILABLE_ARB
:
752 ctx
->Driver
.CheckQuery( ctx
, q
);
756 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjectui64vARB(pname)");
762 * Allocate/init the context state related to query objects.
765 _mesa_init_queryobj(struct gl_context
*ctx
)
767 ctx
->Query
.QueryObjects
= _mesa_NewHashTable();
768 ctx
->Query
.CurrentOcclusionObject
= NULL
;
770 ctx
->Const
.QueryCounterBits
.SamplesPassed
= 64;
771 ctx
->Const
.QueryCounterBits
.TimeElapsed
= 64;
772 ctx
->Const
.QueryCounterBits
.Timestamp
= 64;
773 ctx
->Const
.QueryCounterBits
.PrimitivesGenerated
= 64;
774 ctx
->Const
.QueryCounterBits
.PrimitivesWritten
= 64;
779 * Callback for deleting a query object. Called by _mesa_HashDeleteAll().
782 delete_queryobj_cb(GLuint id
, void *data
, void *userData
)
784 struct gl_query_object
*q
= (struct gl_query_object
*) data
;
785 struct gl_context
*ctx
= (struct gl_context
*)userData
;
786 ctx
->Driver
.DeleteQuery(ctx
, q
);
791 * Free the context state related to query objects.
794 _mesa_free_queryobj_data(struct gl_context
*ctx
)
796 _mesa_HashDeleteAll(ctx
->Query
.QueryObjects
, delete_queryobj_cb
, ctx
);
797 _mesa_DeleteHashTable(ctx
->Query
.QueryObjects
);