1 /**************************************************************************
3 * Copyright 2013 Marek Olšák <maraeo@gmail.com>
6 * Permission is hereby granted, free of charge, to any person obtaining a
7 * copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sub license, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
21 * IN NO EVENT SHALL THE AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR
22 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
23 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
24 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
26 **************************************************************************/
28 /* This head-up display module can draw transparent graphs on top of what
29 * the app is rendering, visualizing various data like framerate, cpu load,
30 * performance counters, etc. It can be hook up into any state tracker.
32 * The HUD is controlled with the GALLIUM_HUD environment variable.
33 * Set GALLIUM_HUD=help for more info.
39 #include "hud/hud_context.h"
40 #include "hud/hud_private.h"
43 #include "cso_cache/cso_context.h"
44 #include "util/u_draw_quad.h"
45 #include "util/u_inlines.h"
46 #include "util/u_memory.h"
47 #include "util/u_math.h"
48 #include "util/u_sampler.h"
49 #include "util/u_simple_shaders.h"
50 #include "util/u_string.h"
51 #include "util/u_upload_mgr.h"
52 #include "tgsi/tgsi_text.h"
53 #include "tgsi/tgsi_dump.h"
55 /* Control the visibility of all HUD contexts */
56 static boolean huds_visible
= TRUE
;
59 struct pipe_context
*pipe
;
60 struct cso_context
*cso
;
61 struct u_upload_mgr
*uploader
;
63 struct hud_batch_query_context
*batch_query
;
64 struct list_head pane_list
;
67 struct pipe_blend_state alpha_blend
;
68 struct pipe_depth_stencil_alpha_state dsa
;
69 void *fs_color
, *fs_text
;
70 struct pipe_rasterizer_state rasterizer
;
72 struct pipe_vertex_element velems
[2];
75 struct util_font font
;
76 struct pipe_sampler_view
*font_sampler_view
;
77 struct pipe_sampler_state font_sampler_state
;
79 /* VS constant buffer */
82 float two_div_fb_width
;
83 float two_div_fb_height
;
88 struct pipe_constant_buffer constbuf
;
90 unsigned fb_width
, fb_height
;
92 /* vertices for text and background drawing are accumulated here and then
93 * drawn all at once */
96 struct pipe_vertex_buffer vbuf
;
97 unsigned max_num_vertices
;
98 unsigned num_vertices
;
99 } text
, bg
, whitelines
;
104 signal_visible_handler(int sig
, siginfo_t
*siginfo
, void *context
)
106 huds_visible
= !huds_visible
;
111 hud_draw_colored_prims(struct hud_context
*hud
, unsigned prim
,
112 float *buffer
, unsigned num_vertices
,
113 float r
, float g
, float b
, float a
,
114 int xoffset
, int yoffset
, float yscale
)
116 struct cso_context
*cso
= hud
->cso
;
117 struct pipe_vertex_buffer vbuffer
= {0};
119 hud
->constants
.color
[0] = r
;
120 hud
->constants
.color
[1] = g
;
121 hud
->constants
.color
[2] = b
;
122 hud
->constants
.color
[3] = a
;
123 hud
->constants
.translate
[0] = (float) xoffset
;
124 hud
->constants
.translate
[1] = (float) yoffset
;
125 hud
->constants
.scale
[0] = 1;
126 hud
->constants
.scale
[1] = yscale
;
127 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
129 vbuffer
.user_buffer
= buffer
;
130 vbuffer
.stride
= 2 * sizeof(float);
132 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
),
134 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
135 cso_draw_arrays(cso
, prim
, 0, num_vertices
);
139 hud_draw_colored_quad(struct hud_context
*hud
, unsigned prim
,
140 unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
141 float r
, float g
, float b
, float a
)
144 (float) x1
, (float) y1
,
145 (float) x1
, (float) y2
,
146 (float) x2
, (float) y2
,
147 (float) x2
, (float) y1
,
150 hud_draw_colored_prims(hud
, prim
, buffer
, 4, r
, g
, b
, a
, 0, 0, 1);
154 hud_draw_background_quad(struct hud_context
*hud
,
155 unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
)
157 float *vertices
= hud
->bg
.vertices
+ hud
->bg
.num_vertices
*2;
160 assert(hud
->bg
.num_vertices
+ 4 <= hud
->bg
.max_num_vertices
);
162 vertices
[num
++] = (float) x1
;
163 vertices
[num
++] = (float) y1
;
165 vertices
[num
++] = (float) x1
;
166 vertices
[num
++] = (float) y2
;
168 vertices
[num
++] = (float) x2
;
169 vertices
[num
++] = (float) y2
;
171 vertices
[num
++] = (float) x2
;
172 vertices
[num
++] = (float) y1
;
174 hud
->bg
.num_vertices
+= num
/2;
178 hud_draw_string(struct hud_context
*hud
, unsigned x
, unsigned y
,
179 const char *str
, ...)
183 float *vertices
= hud
->text
.vertices
+ hud
->text
.num_vertices
*4;
188 util_vsnprintf(buf
, sizeof(buf
), str
, ap
);
194 hud_draw_background_quad(hud
,
196 x
+ strlen(buf
)*hud
->font
.glyph_width
,
197 y
+ hud
->font
.glyph_height
);
202 unsigned x2
= x
+ hud
->font
.glyph_width
;
203 unsigned y2
= y
+ hud
->font
.glyph_height
;
204 unsigned tx1
= (*s
% 16) * hud
->font
.glyph_width
;
205 unsigned ty1
= (*s
/ 16) * hud
->font
.glyph_height
;
206 unsigned tx2
= tx1
+ hud
->font
.glyph_width
;
207 unsigned ty2
= ty1
+ hud
->font
.glyph_height
;
210 x
+= hud
->font
.glyph_width
;
215 assert(hud
->text
.num_vertices
+ num
/4 + 4 <= hud
->text
.max_num_vertices
);
217 vertices
[num
++] = (float) x1
;
218 vertices
[num
++] = (float) y1
;
219 vertices
[num
++] = (float) tx1
;
220 vertices
[num
++] = (float) ty1
;
222 vertices
[num
++] = (float) x1
;
223 vertices
[num
++] = (float) y2
;
224 vertices
[num
++] = (float) tx1
;
225 vertices
[num
++] = (float) ty2
;
227 vertices
[num
++] = (float) x2
;
228 vertices
[num
++] = (float) y2
;
229 vertices
[num
++] = (float) tx2
;
230 vertices
[num
++] = (float) ty2
;
232 vertices
[num
++] = (float) x2
;
233 vertices
[num
++] = (float) y1
;
234 vertices
[num
++] = (float) tx2
;
235 vertices
[num
++] = (float) ty1
;
237 x
+= hud
->font
.glyph_width
;
241 hud
->text
.num_vertices
+= num
/4;
245 number_to_human_readable(uint64_t num
, uint64_t max_value
,
246 enum pipe_driver_query_type type
, char *out
)
248 static const char *byte_units
[] =
249 {" B", " KB", " MB", " GB", " TB", " PB", " EB"};
250 static const char *metric_units
[] =
251 {"", " k", " M", " G", " T", " P", " E"};
252 static const char *time_units
[] =
253 {" us", " ms", " s"}; /* based on microseconds */
254 static const char *hz_units
[] =
255 {" Hz", " KHz", " MHz", " GHz"};
256 static const char *percent_units
[] = {"%"};
260 double divisor
= (type
== PIPE_DRIVER_QUERY_TYPE_BYTES
) ? 1024 : 1000;
265 case PIPE_DRIVER_QUERY_TYPE_MICROSECONDS
:
266 max_unit
= ARRAY_SIZE(time_units
)-1;
269 case PIPE_DRIVER_QUERY_TYPE_PERCENTAGE
:
270 max_unit
= ARRAY_SIZE(percent_units
)-1;
271 units
= percent_units
;
273 case PIPE_DRIVER_QUERY_TYPE_BYTES
:
274 max_unit
= ARRAY_SIZE(byte_units
)-1;
277 case PIPE_DRIVER_QUERY_TYPE_HZ
:
278 max_unit
= ARRAY_SIZE(hz_units
)-1;
282 if (max_value
== 100) {
283 max_unit
= ARRAY_SIZE(percent_units
)-1;
284 units
= percent_units
;
286 max_unit
= ARRAY_SIZE(metric_units
)-1;
287 units
= metric_units
;
291 while (d
> divisor
&& unit
< max_unit
) {
296 if (d
>= 100 || d
== (int)d
)
297 sprintf(out
, "%.0f%s", d
, units
[unit
]);
298 else if (d
>= 10 || d
*10 == (int)(d
*10))
299 sprintf(out
, "%.1f%s", d
, units
[unit
]);
301 sprintf(out
, "%.2f%s", d
, units
[unit
]);
305 hud_draw_graph_line_strip(struct hud_context
*hud
, const struct hud_graph
*gr
,
306 unsigned xoffset
, unsigned yoffset
, float yscale
)
308 if (gr
->num_vertices
<= 1)
311 assert(gr
->index
<= gr
->num_vertices
);
313 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
314 gr
->vertices
, gr
->index
,
315 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
316 xoffset
+ (gr
->pane
->max_num_vertices
- gr
->index
- 1) * 2 - 1,
319 if (gr
->num_vertices
<= gr
->index
)
322 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
323 gr
->vertices
+ gr
->index
*2,
324 gr
->num_vertices
- gr
->index
,
325 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
326 xoffset
- gr
->index
*2 - 1, yoffset
, yscale
);
330 hud_pane_accumulate_vertices(struct hud_context
*hud
,
331 const struct hud_pane
*pane
)
333 struct hud_graph
*gr
;
334 float *line_verts
= hud
->whitelines
.vertices
+ hud
->whitelines
.num_vertices
*2;
338 /* draw background */
339 hud_draw_background_quad(hud
,
343 /* draw numbers on the right-hand side */
344 for (i
= 0; i
< 6; i
++) {
345 unsigned x
= pane
->x2
+ 2;
346 unsigned y
= pane
->inner_y1
+ pane
->inner_height
* (5 - i
) / 5 -
347 hud
->font
.glyph_height
/ 2;
349 number_to_human_readable(pane
->max_value
* i
/ 5, pane
->max_value
,
351 hud_draw_string(hud
, x
, y
, "%s", str
);
354 /* draw info below the pane */
356 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
357 unsigned x
= pane
->x1
+ 2;
358 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
360 number_to_human_readable(gr
->current_value
, pane
->max_value
,
362 hud_draw_string(hud
, x
, y
, " %s: %s", gr
->name
, str
);
367 assert(hud
->whitelines
.num_vertices
+ num
/2 + 8 <= hud
->whitelines
.max_num_vertices
);
368 line_verts
[num
++] = (float) pane
->x1
;
369 line_verts
[num
++] = (float) pane
->y1
;
370 line_verts
[num
++] = (float) pane
->x2
;
371 line_verts
[num
++] = (float) pane
->y1
;
373 line_verts
[num
++] = (float) pane
->x2
;
374 line_verts
[num
++] = (float) pane
->y1
;
375 line_verts
[num
++] = (float) pane
->x2
;
376 line_verts
[num
++] = (float) pane
->y2
;
378 line_verts
[num
++] = (float) pane
->x1
;
379 line_verts
[num
++] = (float) pane
->y2
;
380 line_verts
[num
++] = (float) pane
->x2
;
381 line_verts
[num
++] = (float) pane
->y2
;
383 line_verts
[num
++] = (float) pane
->x1
;
384 line_verts
[num
++] = (float) pane
->y1
;
385 line_verts
[num
++] = (float) pane
->x1
;
386 line_verts
[num
++] = (float) pane
->y2
;
388 /* draw horizontal lines inside the graph */
389 for (i
= 0; i
<= 5; i
++) {
390 float y
= round((pane
->max_value
* i
/ 5.0) * pane
->yscale
+ pane
->inner_y2
);
392 assert(hud
->whitelines
.num_vertices
+ num
/2 + 2 <= hud
->whitelines
.max_num_vertices
);
393 line_verts
[num
++] = pane
->x1
;
394 line_verts
[num
++] = y
;
395 line_verts
[num
++] = pane
->x2
;
396 line_verts
[num
++] = y
;
399 hud
->whitelines
.num_vertices
+= num
/2;
403 hud_pane_draw_colored_objects(struct hud_context
*hud
,
404 const struct hud_pane
*pane
)
406 struct hud_graph
*gr
;
409 /* draw colored quads below the pane */
411 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
412 unsigned x
= pane
->x1
+ 2;
413 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
415 hud_draw_colored_quad(hud
, PIPE_PRIM_QUADS
, x
+ 1, y
+ 1, x
+ 12, y
+ 13,
416 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1);
420 /* draw the line strips */
421 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
422 hud_draw_graph_line_strip(hud
, gr
, pane
->inner_x1
, pane
->inner_y2
, pane
->yscale
);
427 hud_alloc_vertices(struct hud_context
*hud
, struct vertex_queue
*v
,
428 unsigned num_vertices
, unsigned stride
)
431 v
->max_num_vertices
= num_vertices
;
432 v
->vbuf
.stride
= stride
;
433 u_upload_alloc(hud
->uploader
, 0, v
->vbuf
.stride
* v
->max_num_vertices
,
434 16, &v
->vbuf
.buffer_offset
, &v
->vbuf
.buffer
,
435 (void**)&v
->vertices
);
439 * Draw the HUD to the texture \p tex.
440 * The texture is usually the back buffer being displayed.
443 hud_draw(struct hud_context
*hud
, struct pipe_resource
*tex
)
445 struct cso_context
*cso
= hud
->cso
;
446 struct pipe_context
*pipe
= hud
->pipe
;
447 struct pipe_framebuffer_state fb
;
448 struct pipe_surface surf_templ
, *surf
;
449 struct pipe_viewport_state viewport
;
450 const struct pipe_sampler_state
*sampler_states
[] =
451 { &hud
->font_sampler_state
};
452 struct hud_pane
*pane
;
453 struct hud_graph
*gr
;
458 hud
->fb_width
= tex
->width0
;
459 hud
->fb_height
= tex
->height0
;
460 hud
->constants
.two_div_fb_width
= 2.0f
/ hud
->fb_width
;
461 hud
->constants
.two_div_fb_height
= 2.0f
/ hud
->fb_height
;
463 cso_save_state(cso
, (CSO_BIT_FRAMEBUFFER
|
464 CSO_BIT_SAMPLE_MASK
|
465 CSO_BIT_MIN_SAMPLES
|
467 CSO_BIT_DEPTH_STENCIL_ALPHA
|
468 CSO_BIT_FRAGMENT_SHADER
|
469 CSO_BIT_FRAGMENT_SAMPLER_VIEWS
|
470 CSO_BIT_FRAGMENT_SAMPLERS
|
473 CSO_BIT_STREAM_OUTPUTS
|
474 CSO_BIT_GEOMETRY_SHADER
|
475 CSO_BIT_TESSCTRL_SHADER
|
476 CSO_BIT_TESSEVAL_SHADER
|
477 CSO_BIT_VERTEX_SHADER
|
478 CSO_BIT_VERTEX_ELEMENTS
|
479 CSO_BIT_AUX_VERTEX_BUFFER_SLOT
|
480 CSO_BIT_RENDER_CONDITION
));
481 cso_save_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
484 memset(&surf_templ
, 0, sizeof(surf_templ
));
485 surf_templ
.format
= tex
->format
;
486 surf
= pipe
->create_surface(pipe
, tex
, &surf_templ
);
488 memset(&fb
, 0, sizeof(fb
));
492 fb
.width
= hud
->fb_width
;
493 fb
.height
= hud
->fb_height
;
495 viewport
.scale
[0] = 0.5f
* hud
->fb_width
;
496 viewport
.scale
[1] = 0.5f
* hud
->fb_height
;
497 viewport
.scale
[2] = 1.0f
;
498 viewport
.translate
[0] = 0.5f
* hud
->fb_width
;
499 viewport
.translate
[1] = 0.5f
* hud
->fb_height
;
500 viewport
.translate
[2] = 0.0f
;
502 cso_set_framebuffer(cso
, &fb
);
503 cso_set_sample_mask(cso
, ~0);
504 cso_set_min_samples(cso
, 1);
505 cso_set_blend(cso
, &hud
->alpha_blend
);
506 cso_set_depth_stencil_alpha(cso
, &hud
->dsa
);
507 cso_set_rasterizer(cso
, &hud
->rasterizer
);
508 cso_set_viewport(cso
, &viewport
);
509 cso_set_stream_outputs(cso
, 0, NULL
, NULL
);
510 cso_set_tessctrl_shader_handle(cso
, NULL
);
511 cso_set_tesseval_shader_handle(cso
, NULL
);
512 cso_set_geometry_shader_handle(cso
, NULL
);
513 cso_set_vertex_shader_handle(cso
, hud
->vs
);
514 cso_set_vertex_elements(cso
, 2, hud
->velems
);
515 cso_set_render_condition(cso
, NULL
, FALSE
, 0);
516 cso_set_sampler_views(cso
, PIPE_SHADER_FRAGMENT
, 1,
517 &hud
->font_sampler_view
);
518 cso_set_samplers(cso
, PIPE_SHADER_FRAGMENT
, 1, sampler_states
);
519 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
521 /* prepare vertex buffers */
522 hud_alloc_vertices(hud
, &hud
->bg
, 4 * 128, 2 * sizeof(float));
523 hud_alloc_vertices(hud
, &hud
->whitelines
, 4 * 256, 2 * sizeof(float));
524 hud_alloc_vertices(hud
, &hud
->text
, 4 * 512, 4 * sizeof(float));
526 /* prepare all graphs */
527 hud_batch_query_update(hud
->batch_query
);
529 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
530 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
531 gr
->query_new_value(gr
);
534 hud_pane_accumulate_vertices(hud
, pane
);
537 /* unmap the uploader's vertex buffer before drawing */
538 u_upload_unmap(hud
->uploader
);
540 /* draw accumulated vertices for background quads */
541 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
543 if (hud
->bg
.num_vertices
) {
544 hud
->constants
.color
[0] = 0;
545 hud
->constants
.color
[1] = 0;
546 hud
->constants
.color
[2] = 0;
547 hud
->constants
.color
[3] = 0.666f
;
548 hud
->constants
.translate
[0] = 0;
549 hud
->constants
.translate
[1] = 0;
550 hud
->constants
.scale
[0] = 1;
551 hud
->constants
.scale
[1] = 1;
553 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
554 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
556 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->bg
.num_vertices
);
558 pipe_resource_reference(&hud
->bg
.vbuf
.buffer
, NULL
);
560 /* draw accumulated vertices for white lines */
561 hud
->constants
.color
[0] = 1;
562 hud
->constants
.color
[1] = 1;
563 hud
->constants
.color
[2] = 1;
564 hud
->constants
.color
[3] = 1;
565 hud
->constants
.translate
[0] = 0;
566 hud
->constants
.translate
[1] = 0;
567 hud
->constants
.scale
[0] = 1;
568 hud
->constants
.scale
[1] = 1;
569 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
571 if (hud
->whitelines
.num_vertices
) {
572 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
573 &hud
->whitelines
.vbuf
);
574 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
575 cso_draw_arrays(cso
, PIPE_PRIM_LINES
, 0, hud
->whitelines
.num_vertices
);
577 pipe_resource_reference(&hud
->whitelines
.vbuf
.buffer
, NULL
);
579 /* draw accumulated vertices for text */
580 if (hud
->text
.num_vertices
) {
581 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
583 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_text
);
584 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->text
.num_vertices
);
586 pipe_resource_reference(&hud
->text
.vbuf
.buffer
, NULL
);
589 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
591 hud_pane_draw_colored_objects(hud
, pane
);
594 cso_restore_state(cso
);
595 cso_restore_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
597 pipe_surface_reference(&surf
, NULL
);
601 * Set the maximum value for the Y axis of the graph.
602 * This scales the graph accordingly.
605 hud_pane_set_max_value(struct hud_pane
*pane
, uint64_t value
)
607 pane
->max_value
= value
;
608 pane
->yscale
= -(int)pane
->inner_height
/ (float)pane
->max_value
;
612 hud_pane_update_dyn_ceiling(struct hud_graph
*gr
, struct hud_pane
*pane
)
617 if (pane
->dyn_ceil_last_ran
!= gr
->index
) {
618 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
619 for (i
= 0; i
< gr
->num_vertices
; ++i
) {
620 tmp
= gr
->vertices
[i
* 2 + 1] > tmp
?
621 gr
->vertices
[i
* 2 + 1] : tmp
;
625 /* Avoid setting it lower than the initial starting height. */
626 tmp
= tmp
> pane
->initial_max_value
? tmp
: pane
->initial_max_value
;
627 hud_pane_set_max_value(pane
, tmp
);
631 * Mark this adjustment run so we could avoid repeating a full update
632 * again needlessly in case the pane has more than one graph.
634 pane
->dyn_ceil_last_ran
= gr
->index
;
637 static struct hud_pane
*
638 hud_pane_create(unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
639 unsigned period
, uint64_t max_value
, uint64_t ceiling
,
642 struct hud_pane
*pane
= CALLOC_STRUCT(hud_pane
);
651 pane
->inner_x1
= x1
+ 1;
652 pane
->inner_x2
= x2
- 1;
653 pane
->inner_y1
= y1
+ 1;
654 pane
->inner_y2
= y2
- 1;
655 pane
->inner_width
= pane
->inner_x2
- pane
->inner_x1
;
656 pane
->inner_height
= pane
->inner_y2
- pane
->inner_y1
;
657 pane
->period
= period
;
658 pane
->max_num_vertices
= (x2
- x1
+ 2) / 2;
659 pane
->ceiling
= ceiling
;
660 pane
->dyn_ceiling
= dyn_ceiling
;
661 pane
->dyn_ceil_last_ran
= 0;
662 pane
->initial_max_value
= max_value
;
663 hud_pane_set_max_value(pane
, max_value
);
664 LIST_INITHEAD(&pane
->graph_list
);
669 * Add a graph to an existing pane.
670 * One pane can contain multiple graphs over each other.
673 hud_pane_add_graph(struct hud_pane
*pane
, struct hud_graph
*gr
)
675 static const float colors
[][3] = {
684 char *name
= gr
->name
;
686 /* replace '-' with a space */
693 assert(pane
->num_graphs
< Elements(colors
));
694 gr
->vertices
= MALLOC(pane
->max_num_vertices
* sizeof(float) * 2);
695 gr
->color
[0] = colors
[pane
->num_graphs
][0];
696 gr
->color
[1] = colors
[pane
->num_graphs
][1];
697 gr
->color
[2] = colors
[pane
->num_graphs
][2];
699 LIST_ADDTAIL(&gr
->head
, &pane
->graph_list
);
704 hud_graph_add_value(struct hud_graph
*gr
, uint64_t value
)
706 gr
->current_value
= value
;
707 value
= value
> gr
->pane
->ceiling
? gr
->pane
->ceiling
: value
;
709 if (gr
->index
== gr
->pane
->max_num_vertices
) {
711 gr
->vertices
[1] = gr
->vertices
[(gr
->index
-1)*2+1];
714 gr
->vertices
[(gr
->index
)*2+0] = (float) (gr
->index
* 2);
715 gr
->vertices
[(gr
->index
)*2+1] = (float) value
;
718 if (gr
->num_vertices
< gr
->pane
->max_num_vertices
) {
722 if (gr
->pane
->dyn_ceiling
== true) {
723 hud_pane_update_dyn_ceiling(gr
, gr
->pane
);
725 if (value
> gr
->pane
->max_value
) {
726 hud_pane_set_max_value(gr
->pane
, value
);
731 hud_graph_destroy(struct hud_graph
*graph
)
733 FREE(graph
->vertices
);
734 if (graph
->free_query_data
)
735 graph
->free_query_data(graph
->query_data
);
740 * Read a string from the environment variable.
741 * The separators "+", ",", ":", and ";" terminate the string.
742 * Return the number of read characters.
745 parse_string(const char *s
, char *out
)
749 for (i
= 0; *s
&& *s
!= '+' && *s
!= ',' && *s
!= ':' && *s
!= ';';
756 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) while "
757 "parsing a string\n", *s
, *s
);
762 read_pane_settings(char *str
, unsigned * const x
, unsigned * const y
,
763 unsigned * const width
, unsigned * const height
,
764 uint64_t * const ceiling
, boolean
* const dyn_ceiling
)
769 while (*str
== '.') {
774 *x
= strtoul(str
, &ret
, 10);
780 *y
= strtoul(str
, &ret
, 10);
786 tmp
= strtoul(str
, &ret
, 10);
787 *width
= tmp
> 80 ? tmp
: 80; /* 80 is chosen arbitrarily */
792 * Prevent setting height to less than 50. If the height is set to less,
793 * the text of the Y axis labels on the graph will start overlapping.
797 tmp
= strtoul(str
, &ret
, 10);
798 *height
= tmp
> 50 ? tmp
: 50;
804 tmp
= strtoul(str
, &ret
, 10);
805 *ceiling
= tmp
> 10 ? tmp
: 10;
816 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c'\n", *str
);
825 has_occlusion_query(struct pipe_screen
*screen
)
827 return screen
->get_param(screen
, PIPE_CAP_OCCLUSION_QUERY
) != 0;
831 has_streamout(struct pipe_screen
*screen
)
833 return screen
->get_param(screen
, PIPE_CAP_MAX_STREAM_OUTPUT_BUFFERS
) != 0;
837 has_pipeline_stats_query(struct pipe_screen
*screen
)
839 return screen
->get_param(screen
, PIPE_CAP_QUERY_PIPELINE_STATISTICS
) != 0;
843 hud_parse_env_var(struct hud_context
*hud
, const char *env
)
846 char name_a
[256], s
[256];
848 struct hud_pane
*pane
= NULL
;
849 unsigned x
= 10, y
= 10;
850 unsigned width
= 251, height
= 100;
851 unsigned period
= 500 * 1000; /* default period (1/2 second) */
852 uint64_t ceiling
= UINT64_MAX
;
853 unsigned column_width
= 251;
854 boolean dyn_ceiling
= false;
855 const char *period_env
;
858 * The GALLIUM_HUD_PERIOD env var sets the graph update rate.
859 * The env var is in seconds (a float).
860 * Zero means update after every frame.
862 period_env
= getenv("GALLIUM_HUD_PERIOD");
864 float p
= (float) atof(period_env
);
866 period
= (unsigned) (p
* 1000 * 1000);
870 while ((num
= parse_string(env
, name_a
)) != 0) {
873 /* check for explicit location, size and etc. settings */
874 name
= read_pane_settings(name_a
, &x
, &y
, &width
, &height
, &ceiling
,
878 * Keep track of overall column width to avoid pane overlapping in case
879 * later we create a new column while the bottom pane in the current
880 * column is less wide than the rest of the panes in it.
882 column_width
= width
> column_width
? width
: column_width
;
885 pane
= hud_pane_create(x
, y
, x
+ width
, y
+ height
, period
, 10,
886 ceiling
, dyn_ceiling
);
892 /* IF YOU CHANGE THIS, UPDATE print_help! */
893 if (strcmp(name
, "fps") == 0) {
894 hud_fps_graph_install(pane
);
896 else if (strcmp(name
, "cpu") == 0) {
897 hud_cpu_graph_install(pane
, ALL_CPUS
);
899 else if (sscanf(name
, "cpu%u%s", &i
, s
) == 1) {
900 hud_cpu_graph_install(pane
, i
);
902 else if (strcmp(name
, "samples-passed") == 0 &&
903 has_occlusion_query(hud
->pipe
->screen
)) {
904 hud_pipe_query_install(&hud
->batch_query
, pane
, hud
->pipe
,
906 PIPE_QUERY_OCCLUSION_COUNTER
, 0, 0,
907 PIPE_DRIVER_QUERY_TYPE_UINT64
,
908 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
,
911 else if (strcmp(name
, "primitives-generated") == 0 &&
912 has_streamout(hud
->pipe
->screen
)) {
913 hud_pipe_query_install(&hud
->batch_query
, pane
, hud
->pipe
,
914 "primitives-generated",
915 PIPE_QUERY_PRIMITIVES_GENERATED
, 0, 0,
916 PIPE_DRIVER_QUERY_TYPE_UINT64
,
917 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
,
921 boolean processed
= FALSE
;
923 /* pipeline statistics queries */
924 if (has_pipeline_stats_query(hud
->pipe
->screen
)) {
925 static const char *pipeline_statistics_names
[] =
932 "clipper-invocations",
933 "clipper-primitives-generated",
939 for (i
= 0; i
< Elements(pipeline_statistics_names
); ++i
)
940 if (strcmp(name
, pipeline_statistics_names
[i
]) == 0)
942 if (i
< Elements(pipeline_statistics_names
)) {
943 hud_pipe_query_install(&hud
->batch_query
, pane
, hud
->pipe
, name
,
944 PIPE_QUERY_PIPELINE_STATISTICS
, i
,
945 0, PIPE_DRIVER_QUERY_TYPE_UINT64
,
946 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
,
954 if (!hud_driver_query_install(&hud
->batch_query
, pane
, hud
->pipe
,
956 fprintf(stderr
, "gallium_hud: unknown driver query '%s'\n", name
);
965 fprintf(stderr
, "gallium_hud: syntax error: unexpected ':', "
966 "expected a name\n");
970 num
= parse_string(env
, s
);
973 if (num
&& sscanf(s
, "%u", &i
) == 1) {
974 hud_pane_set_max_value(pane
, i
);
975 pane
->initial_max_value
= i
;
978 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) "
979 "after ':'\n", *env
, *env
);
986 /* parse a separator */
997 y
+= height
+ hud
->font
.glyph_height
* (pane
->num_graphs
+ 2);
1000 if (pane
&& pane
->num_graphs
) {
1001 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
1009 x
+= column_width
+ hud
->font
.glyph_width
* 7;
1012 if (pane
&& pane
->num_graphs
) {
1013 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
1017 /* Starting a new column; reset column width. */
1022 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c'\n", *env
);
1025 /* Reset to defaults for the next pane in case these were modified. */
1027 ceiling
= UINT64_MAX
;
1028 dyn_ceiling
= false;
1033 if (pane
->num_graphs
) {
1034 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
1043 print_help(struct pipe_screen
*screen
)
1045 int i
, num_queries
, num_cpus
= hud_get_num_cpus();
1047 puts("Syntax: GALLIUM_HUD=name1[+name2][...][:value1][,nameI...][;nameJ...]");
1049 puts(" Names are identifiers of data sources which will be drawn as graphs");
1050 puts(" in panes. Multiple graphs can be drawn in the same pane.");
1051 puts(" There can be multiple panes placed in rows and columns.");
1053 puts(" '+' separates names which will share a pane.");
1054 puts(" ':[value]' specifies the initial maximum value of the Y axis");
1055 puts(" for the given pane.");
1056 puts(" ',' creates a new pane below the last one.");
1057 puts(" ';' creates a new pane at the top of the next column.");
1059 puts(" Example: GALLIUM_HUD=\"cpu,fps;primitives-generated\"");
1061 puts(" Additionally, by prepending '.[identifier][value]' modifiers to");
1062 puts(" a name, it is possible to explicitly set the location and size");
1063 puts(" of a pane, along with limiting overall maximum value of the");
1064 puts(" Y axis and activating dynamic readjustment of the Y axis.");
1065 puts(" Several modifiers may be applied to the same pane simultaneously.");
1067 puts(" 'x[value]' sets the location of the pane on the x axis relative");
1068 puts(" to the upper-left corner of the viewport, in pixels.");
1069 puts(" 'y[value]' sets the location of the pane on the y axis relative");
1070 puts(" to the upper-left corner of the viewport, in pixels.");
1071 puts(" 'w[value]' sets width of the graph pixels.");
1072 puts(" 'h[value]' sets height of the graph in pixels.");
1073 puts(" 'c[value]' sets the ceiling of the value of the Y axis.");
1074 puts(" If the graph needs to draw values higher than");
1075 puts(" the ceiling allows, the value is clamped.");
1076 puts(" 'd' activates dynamic Y axis readjustment to set the value of");
1077 puts(" the Y axis to match the highest value still visible in the graph.");
1079 puts(" If 'c' and 'd' modifiers are used simultaneously, both are in effect:");
1080 puts(" the Y axis does not go above the restriction imposed by 'c' while");
1081 puts(" still adjusting the value of the Y axis down when appropriate.");
1083 puts(" Example: GALLIUM_HUD=\".w256.h64.x1600.y520.d.c1000fps+cpu,.datom-count\"");
1085 puts(" Available names:");
1089 for (i
= 0; i
< num_cpus
; i
++)
1090 printf(" cpu%i\n", i
);
1092 if (has_occlusion_query(screen
))
1093 puts(" samples-passed");
1094 if (has_streamout(screen
))
1095 puts(" primitives-generated");
1097 if (has_pipeline_stats_query(screen
)) {
1098 puts(" ia-vertices");
1099 puts(" ia-primitives");
1100 puts(" vs-invocations");
1101 puts(" gs-invocations");
1102 puts(" gs-primitives");
1103 puts(" clipper-invocations");
1104 puts(" clipper-primitives-generated");
1105 puts(" ps-invocations");
1106 puts(" hs-invocations");
1107 puts(" ds-invocations");
1108 puts(" cs-invocations");
1111 if (screen
->get_driver_query_info
){
1112 boolean skipping
= false;
1113 struct pipe_driver_query_info info
;
1114 num_queries
= screen
->get_driver_query_info(screen
, 0, NULL
);
1116 for (i
= 0; i
< num_queries
; i
++){
1117 screen
->get_driver_query_info(screen
, i
, &info
);
1118 if (info
.flags
& PIPE_DRIVER_QUERY_FLAG_DONT_LIST
) {
1123 printf(" %s\n", info
.name
);
1133 struct hud_context
*
1134 hud_create(struct pipe_context
*pipe
, struct cso_context
*cso
)
1136 struct hud_context
*hud
;
1137 struct pipe_sampler_view view_templ
;
1139 const char *env
= debug_get_option("GALLIUM_HUD", NULL
);
1140 unsigned signo
= debug_get_num_option("GALLIUM_HUD_TOGGLE_SIGNAL", 0);
1142 static boolean sig_handled
= FALSE
;
1143 struct sigaction action
= {};
1145 huds_visible
= debug_get_bool_option("GALLIUM_HUD_VISIBLE", TRUE
);
1150 if (strcmp(env
, "help") == 0) {
1151 print_help(pipe
->screen
);
1155 hud
= CALLOC_STRUCT(hud_context
);
1161 hud
->uploader
= u_upload_create(pipe
, 256 * 1024,
1162 PIPE_BIND_VERTEX_BUFFER
, PIPE_USAGE_STREAM
);
1165 if (!util_font_create(pipe
, UTIL_FONT_FIXED_8X13
, &hud
->font
)) {
1166 u_upload_destroy(hud
->uploader
);
1172 hud
->alpha_blend
.rt
[0].colormask
= PIPE_MASK_RGBA
;
1173 hud
->alpha_blend
.rt
[0].blend_enable
= 1;
1174 hud
->alpha_blend
.rt
[0].rgb_func
= PIPE_BLEND_ADD
;
1175 hud
->alpha_blend
.rt
[0].rgb_src_factor
= PIPE_BLENDFACTOR_SRC_ALPHA
;
1176 hud
->alpha_blend
.rt
[0].rgb_dst_factor
= PIPE_BLENDFACTOR_INV_SRC_ALPHA
;
1177 hud
->alpha_blend
.rt
[0].alpha_func
= PIPE_BLEND_ADD
;
1178 hud
->alpha_blend
.rt
[0].alpha_src_factor
= PIPE_BLENDFACTOR_ZERO
;
1179 hud
->alpha_blend
.rt
[0].alpha_dst_factor
= PIPE_BLENDFACTOR_ONE
;
1181 /* fragment shader */
1183 util_make_fragment_passthrough_shader(pipe
,
1184 TGSI_SEMANTIC_COLOR
,
1185 TGSI_INTERPOLATE_CONSTANT
,
1189 /* Read a texture and do .xxxx swizzling. */
1190 static const char *fragment_shader_text
= {
1192 "DCL IN[0], GENERIC[0], LINEAR\n"
1194 "DCL OUT[0], COLOR[0]\n"
1197 "TEX TEMP[0], IN[0], SAMP[0], RECT\n"
1198 "MOV OUT[0], TEMP[0].xxxx\n"
1202 struct tgsi_token tokens
[1000];
1203 struct pipe_shader_state state
= {tokens
};
1205 if (!tgsi_text_translate(fragment_shader_text
, tokens
, Elements(tokens
))) {
1207 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1208 u_upload_destroy(hud
->uploader
);
1213 hud
->fs_text
= pipe
->create_fs_state(pipe
, &state
);
1217 hud
->rasterizer
.half_pixel_center
= 1;
1218 hud
->rasterizer
.bottom_edge_rule
= 1;
1219 hud
->rasterizer
.depth_clip
= 1;
1220 hud
->rasterizer
.line_width
= 1;
1221 hud
->rasterizer
.line_last_pixel
= 1;
1225 static const char *vertex_shader_text
= {
1228 "DCL OUT[0], POSITION\n"
1229 "DCL OUT[1], COLOR[0]\n" /* color */
1230 "DCL OUT[2], GENERIC[0]\n" /* texcoord */
1232 * [1] = (2/fb_width, 2/fb_height, xoffset, yoffset)
1233 * [2] = (xscale, yscale, 0, 0) */
1236 "IMM[0] FLT32 { -1, 0, 0, 1 }\n"
1238 /* v = in * (xscale, yscale) + (xoffset, yoffset) */
1239 "MAD TEMP[0].xy, IN[0], CONST[2].xyyy, CONST[1].zwww\n"
1240 /* pos = v * (2 / fb_width, 2 / fb_height) - (1, 1) */
1241 "MAD OUT[0].xy, TEMP[0], CONST[1].xyyy, IMM[0].xxxx\n"
1242 "MOV OUT[0].zw, IMM[0]\n"
1244 "MOV OUT[1], CONST[0]\n"
1245 "MOV OUT[2], IN[1]\n"
1249 struct tgsi_token tokens
[1000];
1250 struct pipe_shader_state state
= {tokens
};
1252 if (!tgsi_text_translate(vertex_shader_text
, tokens
, Elements(tokens
))) {
1254 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1255 u_upload_destroy(hud
->uploader
);
1260 hud
->vs
= pipe
->create_vs_state(pipe
, &state
);
1263 /* vertex elements */
1264 for (i
= 0; i
< 2; i
++) {
1265 hud
->velems
[i
].src_offset
= i
* 2 * sizeof(float);
1266 hud
->velems
[i
].src_format
= PIPE_FORMAT_R32G32_FLOAT
;
1267 hud
->velems
[i
].vertex_buffer_index
= cso_get_aux_vertex_buffer_slot(cso
);
1271 u_sampler_view_default_template(
1272 &view_templ
, hud
->font
.texture
, hud
->font
.texture
->format
);
1273 hud
->font_sampler_view
= pipe
->create_sampler_view(pipe
, hud
->font
.texture
,
1276 /* sampler state (for font drawing) */
1277 hud
->font_sampler_state
.wrap_s
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1278 hud
->font_sampler_state
.wrap_t
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1279 hud
->font_sampler_state
.wrap_r
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1280 hud
->font_sampler_state
.normalized_coords
= 0;
1283 hud
->constbuf
.buffer_size
= sizeof(hud
->constants
);
1284 hud
->constbuf
.user_buffer
= &hud
->constants
;
1286 LIST_INITHEAD(&hud
->pane_list
);
1288 /* setup sig handler once for all hud contexts */
1290 if (!sig_handled
&& signo
!= 0) {
1291 action
.sa_sigaction
= &signal_visible_handler
;
1292 action
.sa_flags
= SA_SIGINFO
;
1295 fprintf(stderr
, "gallium_hud: invalid signal %u\n", signo
);
1296 else if (sigaction(signo
, &action
, NULL
) < 0)
1297 fprintf(stderr
, "gallium_hud: unable to set handler for signal %u\n", signo
);
1304 hud_parse_env_var(hud
, env
);
1309 hud_destroy(struct hud_context
*hud
)
1311 struct pipe_context
*pipe
= hud
->pipe
;
1312 struct hud_pane
*pane
, *pane_tmp
;
1313 struct hud_graph
*graph
, *graph_tmp
;
1315 LIST_FOR_EACH_ENTRY_SAFE(pane
, pane_tmp
, &hud
->pane_list
, head
) {
1316 LIST_FOR_EACH_ENTRY_SAFE(graph
, graph_tmp
, &pane
->graph_list
, head
) {
1317 LIST_DEL(&graph
->head
);
1318 hud_graph_destroy(graph
);
1320 LIST_DEL(&pane
->head
);
1324 hud_batch_query_cleanup(&hud
->batch_query
);
1325 pipe
->delete_fs_state(pipe
, hud
->fs_color
);
1326 pipe
->delete_fs_state(pipe
, hud
->fs_text
);
1327 pipe
->delete_vs_state(pipe
, hud
->vs
);
1328 pipe_sampler_view_reference(&hud
->font_sampler_view
, NULL
);
1329 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1330 u_upload_destroy(hud
->uploader
);