2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2007 Brian Paul All Rights Reserved.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 #include "mfeatures.h"
34 #include "main/dispatch.h"
41 * Allocate a new query object. This is a fallback routine called via
42 * ctx->Driver.NewQueryObject().
43 * \param ctx - rendering context
44 * \param id - the new object's ID
45 * \return pointer to new query_object object or NULL if out of memory.
47 static struct gl_query_object
*
48 _mesa_new_query_object(struct gl_context
*ctx
, GLuint id
)
50 struct gl_query_object
*q
= MALLOC_STRUCT(gl_query_object
);
56 q
->Ready
= GL_TRUE
; /* correct, see spec */
63 * Begin a query. Software driver fallback.
64 * Called via ctx->Driver.BeginQuery().
67 _mesa_begin_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
74 * End a query. Software driver fallback.
75 * Called via ctx->Driver.EndQuery().
78 _mesa_end_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
85 * Wait for query to complete. Software driver fallback.
86 * Called via ctx->Driver.WaitQuery().
89 _mesa_wait_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
91 /* For software drivers, _mesa_end_query() should have completed the query.
92 * For real hardware, implement a proper WaitQuery() driver function,
93 * which may require issuing a flush.
100 * Check if a query results are ready. Software driver fallback.
101 * Called via ctx->Driver.CheckQuery().
104 _mesa_check_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
106 /* No-op for sw rendering.
107 * HW drivers may need to flush at this time.
113 * Delete a query object. Called via ctx->Driver.DeleteQuery().
114 * Not removed from hash table here.
117 _mesa_delete_query(struct gl_context
*ctx
, struct gl_query_object
*q
)
124 _mesa_init_query_object_functions(struct dd_function_table
*driver
)
126 driver
->NewQueryObject
= _mesa_new_query_object
;
127 driver
->DeleteQuery
= _mesa_delete_query
;
128 driver
->BeginQuery
= _mesa_begin_query
;
129 driver
->EndQuery
= _mesa_end_query
;
130 driver
->WaitQuery
= _mesa_wait_query
;
131 driver
->CheckQuery
= _mesa_check_query
;
136 * Return pointer to the query object binding point for the given target.
137 * \return NULL if invalid target, else the address of binding point
139 static struct gl_query_object
**
140 get_query_binding_point(struct gl_context
*ctx
, GLenum target
)
143 case GL_SAMPLES_PASSED_ARB
:
144 if (ctx
->Extensions
.ARB_occlusion_query
)
145 return &ctx
->Query
.CurrentOcclusionObject
;
148 case GL_ANY_SAMPLES_PASSED
:
149 if (ctx
->Extensions
.ARB_occlusion_query2
)
150 return &ctx
->Query
.CurrentOcclusionObject
;
153 case GL_TIME_ELAPSED_EXT
:
154 if (ctx
->Extensions
.EXT_timer_query
)
155 return &ctx
->Query
.CurrentTimerObject
;
158 #if FEATURE_EXT_transform_feedback
159 case GL_PRIMITIVES_GENERATED
:
160 if (ctx
->Extensions
.EXT_transform_feedback
)
161 return &ctx
->Query
.PrimitivesGenerated
;
164 case GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
:
165 if (ctx
->Extensions
.EXT_transform_feedback
)
166 return &ctx
->Query
.PrimitivesWritten
;
176 static void GLAPIENTRY
177 _mesa_GenQueriesARB(GLsizei n
, GLuint
*ids
)
180 GET_CURRENT_CONTEXT(ctx
);
181 ASSERT_OUTSIDE_BEGIN_END(ctx
);
183 if (MESA_VERBOSE
& VERBOSE_API
)
184 _mesa_debug(ctx
, "glGenQueries(%d)\n", n
);
187 _mesa_error(ctx
, GL_INVALID_VALUE
, "glGenQueriesARB(n < 0)");
191 /* No query objects can be active at this time! */
192 if (ctx
->Query
.CurrentOcclusionObject
||
193 ctx
->Query
.CurrentTimerObject
) {
194 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glGenQueriesARB");
198 first
= _mesa_HashFindFreeKeyBlock(ctx
->Query
.QueryObjects
, n
);
201 for (i
= 0; i
< n
; i
++) {
202 struct gl_query_object
*q
203 = ctx
->Driver
.NewQueryObject(ctx
, first
+ i
);
205 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glGenQueriesARB");
209 _mesa_HashInsert(ctx
->Query
.QueryObjects
, first
+ i
, q
);
215 static void GLAPIENTRY
216 _mesa_DeleteQueriesARB(GLsizei n
, const GLuint
*ids
)
219 GET_CURRENT_CONTEXT(ctx
);
220 ASSERT_OUTSIDE_BEGIN_END(ctx
);
221 FLUSH_VERTICES(ctx
, 0);
223 if (MESA_VERBOSE
& VERBOSE_API
)
224 _mesa_debug(ctx
, "glDeleeteQueries(%d)\n", n
);
227 _mesa_error(ctx
, GL_INVALID_VALUE
, "glDeleteQueriesARB(n < 0)");
231 /* No query objects can be active at this time! */
232 if (ctx
->Query
.CurrentOcclusionObject
||
233 ctx
->Query
.CurrentTimerObject
) {
234 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glDeleteQueriesARB");
238 for (i
= 0; i
< n
; i
++) {
240 struct gl_query_object
*q
= _mesa_lookup_query_object(ctx
, ids
[i
]);
242 ASSERT(!q
->Active
); /* should be caught earlier */
243 _mesa_HashRemove(ctx
->Query
.QueryObjects
, ids
[i
]);
244 ctx
->Driver
.DeleteQuery(ctx
, q
);
251 static GLboolean GLAPIENTRY
252 _mesa_IsQueryARB(GLuint id
)
254 GET_CURRENT_CONTEXT(ctx
);
255 ASSERT_OUTSIDE_BEGIN_END_WITH_RETVAL(ctx
, GL_FALSE
);
257 if (MESA_VERBOSE
& VERBOSE_API
)
258 _mesa_debug(ctx
, "glIsQuery(%u)\n", id
);
260 if (id
&& _mesa_lookup_query_object(ctx
, id
))
267 query_error_check_index(struct gl_context
*ctx
, GLenum target
, GLuint index
)
270 case GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
:
271 case GL_PRIMITIVES_GENERATED
:
272 if (index
>= ctx
->Const
.MaxVertexStreams
) {
273 _mesa_error(ctx
, GL_INVALID_VALUE
,
274 "glBeginQueryIndexed(index>=MaxVertexStreams)");
280 _mesa_error(ctx
, GL_INVALID_VALUE
, "glBeginQueryIndexed(index>0)");
287 static void GLAPIENTRY
288 _mesa_BeginQueryIndexed(GLenum target
, GLuint index
, GLuint id
)
290 struct gl_query_object
*q
, **bindpt
;
291 GET_CURRENT_CONTEXT(ctx
);
292 ASSERT_OUTSIDE_BEGIN_END(ctx
);
294 if (MESA_VERBOSE
& VERBOSE_API
)
295 _mesa_debug(ctx
, "glBeginQueryIndexed(%s, %u, %u)\n",
296 _mesa_lookup_enum_by_nr(target
), index
, id
);
298 if (!query_error_check_index(ctx
, target
, index
))
301 FLUSH_VERTICES(ctx
, _NEW_DEPTH
);
303 bindpt
= get_query_binding_point(ctx
, target
);
305 _mesa_error(ctx
, GL_INVALID_ENUM
, "glBeginQuery{Indexed}(target)");
310 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glBeginQuery{Indexed}(id==0)");
314 q
= _mesa_lookup_query_object(ctx
, id
);
316 /* create new object */
317 q
= ctx
->Driver
.NewQueryObject(ctx
, id
);
319 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glBeginQuery{Indexed}");
322 _mesa_HashInsert(ctx
->Query
.QueryObjects
, id
, q
);
325 /* pre-existing object */
327 _mesa_error(ctx
, GL_INVALID_OPERATION
,
328 "glBeginQuery{Indexed}(query already active)");
338 /* XXX should probably refcount query objects */
341 ctx
->Driver
.BeginQuery(ctx
, q
);
345 static void GLAPIENTRY
346 _mesa_EndQueryIndexed(GLenum target
, GLuint index
)
348 struct gl_query_object
*q
, **bindpt
;
349 GET_CURRENT_CONTEXT(ctx
);
350 ASSERT_OUTSIDE_BEGIN_END(ctx
);
352 if (MESA_VERBOSE
& VERBOSE_API
)
353 _mesa_debug(ctx
, "glEndQueryIndexed(%s, %u)\n",
354 _mesa_lookup_enum_by_nr(target
), index
);
356 if (!query_error_check_index(ctx
, target
, index
))
359 FLUSH_VERTICES(ctx
, _NEW_DEPTH
);
361 bindpt
= get_query_binding_point(ctx
, target
);
363 _mesa_error(ctx
, GL_INVALID_ENUM
, "glEndQuery{Indexed}(target)");
367 /* XXX should probably refcount query objects */
371 if (!q
|| !q
->Active
) {
372 _mesa_error(ctx
, GL_INVALID_OPERATION
,
373 "glEndQuery{Indexed}(no matching glBeginQuery{Indexed})");
377 q
->Active
= GL_FALSE
;
378 ctx
->Driver
.EndQuery(ctx
, q
);
381 static void GLAPIENTRY
382 _mesa_BeginQueryARB(GLenum target
, GLuint id
)
384 _mesa_BeginQueryIndexed(target
, 0, id
);
387 static void GLAPIENTRY
388 _mesa_EndQueryARB(GLenum target
)
390 _mesa_EndQueryIndexed(target
, 0);
393 static void GLAPIENTRY
394 _mesa_QueryCounter(GLuint id
, GLenum target
)
396 struct gl_query_object
*q
;
397 GET_CURRENT_CONTEXT(ctx
);
398 ASSERT_OUTSIDE_BEGIN_END(ctx
);
400 if (MESA_VERBOSE
& VERBOSE_API
)
401 _mesa_debug(ctx
, "glQueryCounter(%u, %s)\n", id
,
402 _mesa_lookup_enum_by_nr(target
));
405 if (target
!= GL_TIMESTAMP
) {
406 _mesa_error(ctx
, GL_INVALID_ENUM
, "glQueryCounter(target)");
411 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glQueryCounter(id==0)");
415 q
= _mesa_lookup_query_object(ctx
, id
);
417 /* XXX the Core profile should throw INVALID_OPERATION here */
419 /* create new object */
420 q
= ctx
->Driver
.NewQueryObject(ctx
, id
);
422 _mesa_error(ctx
, GL_OUT_OF_MEMORY
, "glQueryCounter");
425 _mesa_HashInsert(ctx
->Query
.QueryObjects
, id
, q
);
428 if (q
->Target
&& q
->Target
!= GL_TIMESTAMP
) {
429 _mesa_error(ctx
, GL_INVALID_OPERATION
,
430 "glQueryCounter(id has an invalid target)");
436 _mesa_error(ctx
, GL_INVALID_OPERATION
, "glQueryCounter(id is active)");
444 /* QueryCounter is implemented using EndQuery without BeginQuery
445 * in drivers. This is actually Direct3D and Gallium convention. */
446 ctx
->Driver
.EndQuery(ctx
, q
);
450 static void GLAPIENTRY
451 _mesa_GetQueryIndexediv(GLenum target
, GLuint index
, GLenum pname
,
454 struct gl_query_object
*q
= NULL
, **bindpt
= NULL
;
455 GET_CURRENT_CONTEXT(ctx
);
456 ASSERT_OUTSIDE_BEGIN_END(ctx
);
458 if (MESA_VERBOSE
& VERBOSE_API
)
459 _mesa_debug(ctx
, "glGetQueryIndexediv(%s, %u, %s)\n",
460 _mesa_lookup_enum_by_nr(target
),
462 _mesa_lookup_enum_by_nr(pname
));
464 if (!query_error_check_index(ctx
, target
, index
))
467 if (target
== GL_TIMESTAMP
) {
468 if (!ctx
->Extensions
.ARB_timer_query
) {
469 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryARB(target)");
474 bindpt
= get_query_binding_point(ctx
, target
);
476 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQuery{Indexed}iv(target)");
484 case GL_QUERY_COUNTER_BITS_ARB
:
486 case GL_SAMPLES_PASSED
:
487 *params
= ctx
->Const
.QueryCounterBits
.SamplesPassed
;
489 case GL_ANY_SAMPLES_PASSED
:
490 /* The minimum value of this is 1 if it's nonzero, and the value
491 * is only ever GL_TRUE or GL_FALSE, so no sense in reporting more
496 case GL_TIME_ELAPSED
:
497 *params
= ctx
->Const
.QueryCounterBits
.TimeElapsed
;
500 *params
= ctx
->Const
.QueryCounterBits
.Timestamp
;
502 case GL_PRIMITIVES_GENERATED
:
503 *params
= ctx
->Const
.QueryCounterBits
.PrimitivesGenerated
;
505 case GL_TRANSFORM_FEEDBACK_PRIMITIVES_WRITTEN
:
506 *params
= ctx
->Const
.QueryCounterBits
.PrimitivesWritten
;
510 "Unknown target in glGetQueryIndexediv(target = %s)",
511 _mesa_lookup_enum_by_nr(target
));
516 case GL_CURRENT_QUERY_ARB
:
517 *params
= q
? q
->Id
: 0;
520 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQuery{Indexed}iv(pname)");
525 static void GLAPIENTRY
526 _mesa_GetQueryivARB(GLenum target
, GLenum pname
, GLint
*params
)
528 _mesa_GetQueryIndexediv(target
, 0, pname
, params
);
531 static void GLAPIENTRY
532 _mesa_GetQueryObjectivARB(GLuint id
, GLenum pname
, GLint
*params
)
534 struct gl_query_object
*q
= NULL
;
535 GET_CURRENT_CONTEXT(ctx
);
536 ASSERT_OUTSIDE_BEGIN_END(ctx
);
538 if (MESA_VERBOSE
& VERBOSE_API
)
539 _mesa_debug(ctx
, "glGetQueryObjectiv(%u, %s)\n", id
,
540 _mesa_lookup_enum_by_nr(pname
));
543 q
= _mesa_lookup_query_object(ctx
, id
);
545 if (!q
|| q
->Active
) {
546 _mesa_error(ctx
, GL_INVALID_OPERATION
,
547 "glGetQueryObjectivARB(id=%d is invalid or active)", id
);
552 case GL_QUERY_RESULT_ARB
:
554 ctx
->Driver
.WaitQuery(ctx
, q
);
555 /* if result is too large for returned type, clamp to max value */
556 if (q
->Target
== GL_ANY_SAMPLES_PASSED
) {
562 if (q
->Result
> 0x7fffffff) {
563 *params
= 0x7fffffff;
566 *params
= (GLint
)q
->Result
;
570 case GL_QUERY_RESULT_AVAILABLE_ARB
:
572 ctx
->Driver
.CheckQuery( ctx
, q
);
576 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjectivARB(pname)");
582 static void GLAPIENTRY
583 _mesa_GetQueryObjectuivARB(GLuint id
, GLenum pname
, GLuint
*params
)
585 struct gl_query_object
*q
= NULL
;
586 GET_CURRENT_CONTEXT(ctx
);
587 ASSERT_OUTSIDE_BEGIN_END(ctx
);
589 if (MESA_VERBOSE
& VERBOSE_API
)
590 _mesa_debug(ctx
, "glGetQueryObjectuiv(%u, %s)\n", id
,
591 _mesa_lookup_enum_by_nr(pname
));
594 q
= _mesa_lookup_query_object(ctx
, id
);
596 if (!q
|| q
->Active
) {
597 _mesa_error(ctx
, GL_INVALID_OPERATION
,
598 "glGetQueryObjectuivARB(id=%d is invalid or active)", id
);
603 case GL_QUERY_RESULT_ARB
:
605 ctx
->Driver
.WaitQuery(ctx
, q
);
606 /* if result is too large for returned type, clamp to max value */
607 if (q
->Target
== GL_ANY_SAMPLES_PASSED
) {
613 if (q
->Result
> 0xffffffff) {
614 *params
= 0xffffffff;
617 *params
= (GLuint
)q
->Result
;
621 case GL_QUERY_RESULT_AVAILABLE_ARB
:
623 ctx
->Driver
.CheckQuery( ctx
, q
);
627 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjectuivARB(pname)");
634 * New with GL_EXT_timer_query
636 static void GLAPIENTRY
637 _mesa_GetQueryObjecti64vEXT(GLuint id
, GLenum pname
, GLint64EXT
*params
)
639 struct gl_query_object
*q
= NULL
;
640 GET_CURRENT_CONTEXT(ctx
);
641 ASSERT_OUTSIDE_BEGIN_END(ctx
);
643 if (MESA_VERBOSE
& VERBOSE_API
)
644 _mesa_debug(ctx
, "glGetQueryObjecti64v(%u, %s)\n", id
,
645 _mesa_lookup_enum_by_nr(pname
));
648 q
= _mesa_lookup_query_object(ctx
, id
);
650 if (!q
|| q
->Active
) {
651 _mesa_error(ctx
, GL_INVALID_OPERATION
,
652 "glGetQueryObjectui64vARB(id=%d is invalid or active)", id
);
657 case GL_QUERY_RESULT_ARB
:
659 ctx
->Driver
.WaitQuery(ctx
, q
);
662 case GL_QUERY_RESULT_AVAILABLE_ARB
:
664 ctx
->Driver
.CheckQuery( ctx
, q
);
668 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjecti64vARB(pname)");
675 * New with GL_EXT_timer_query
677 static void GLAPIENTRY
678 _mesa_GetQueryObjectui64vEXT(GLuint id
, GLenum pname
, GLuint64EXT
*params
)
680 struct gl_query_object
*q
= NULL
;
681 GET_CURRENT_CONTEXT(ctx
);
682 ASSERT_OUTSIDE_BEGIN_END(ctx
);
684 if (MESA_VERBOSE
& VERBOSE_API
)
685 _mesa_debug(ctx
, "glGetQueryObjectui64v(%u, %s)\n", id
,
686 _mesa_lookup_enum_by_nr(pname
));
689 q
= _mesa_lookup_query_object(ctx
, id
);
691 if (!q
|| q
->Active
) {
692 _mesa_error(ctx
, GL_INVALID_OPERATION
,
693 "glGetQueryObjectuui64vARB(id=%d is invalid or active)", id
);
698 case GL_QUERY_RESULT_ARB
:
700 ctx
->Driver
.WaitQuery(ctx
, q
);
703 case GL_QUERY_RESULT_AVAILABLE_ARB
:
705 ctx
->Driver
.CheckQuery( ctx
, q
);
709 _mesa_error(ctx
, GL_INVALID_ENUM
, "glGetQueryObjectui64vARB(pname)");
716 _mesa_init_queryobj_dispatch(struct _glapi_table
*disp
)
718 SET_GenQueriesARB(disp
, _mesa_GenQueriesARB
);
719 SET_DeleteQueriesARB(disp
, _mesa_DeleteQueriesARB
);
720 SET_IsQueryARB(disp
, _mesa_IsQueryARB
);
721 SET_BeginQueryARB(disp
, _mesa_BeginQueryARB
);
722 SET_EndQueryARB(disp
, _mesa_EndQueryARB
);
723 SET_GetQueryivARB(disp
, _mesa_GetQueryivARB
);
724 SET_GetQueryObjectivARB(disp
, _mesa_GetQueryObjectivARB
);
725 SET_GetQueryObjectuivARB(disp
, _mesa_GetQueryObjectuivARB
);
726 SET_QueryCounter(disp
, _mesa_QueryCounter
);
728 SET_GetQueryObjecti64vEXT(disp
, _mesa_GetQueryObjecti64vEXT
);
729 SET_GetQueryObjectui64vEXT(disp
, _mesa_GetQueryObjectui64vEXT
);
731 SET_BeginQueryIndexed(disp
, _mesa_BeginQueryIndexed
);
732 SET_EndQueryIndexed(disp
, _mesa_EndQueryIndexed
);
733 SET_GetQueryIndexediv(disp
, _mesa_GetQueryIndexediv
);
737 #endif /* FEATURE_queryobj */
741 * Allocate/init the context state related to query objects.
744 _mesa_init_queryobj(struct gl_context
*ctx
)
746 ctx
->Query
.QueryObjects
= _mesa_NewHashTable();
747 ctx
->Query
.CurrentOcclusionObject
= NULL
;
749 ctx
->Const
.QueryCounterBits
.SamplesPassed
= 64;
750 ctx
->Const
.QueryCounterBits
.TimeElapsed
= 64;
751 ctx
->Const
.QueryCounterBits
.Timestamp
= 64;
752 ctx
->Const
.QueryCounterBits
.PrimitivesGenerated
= 64;
753 ctx
->Const
.QueryCounterBits
.PrimitivesWritten
= 64;
758 * Callback for deleting a query object. Called by _mesa_HashDeleteAll().
761 delete_queryobj_cb(GLuint id
, void *data
, void *userData
)
763 struct gl_query_object
*q
= (struct gl_query_object
*) data
;
764 struct gl_context
*ctx
= (struct gl_context
*)userData
;
765 ctx
->Driver
.DeleteQuery(ctx
, q
);
770 * Free the context state related to query objects.
773 _mesa_free_queryobj_data(struct gl_context
*ctx
)
775 _mesa_HashDeleteAll(ctx
->Query
.QueryObjects
, delete_queryobj_cb
, ctx
);
776 _mesa_DeleteHashTable(ctx
->Query
.QueryObjects
);