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.
38 #include "hud/hud_context.h"
39 #include "hud/hud_private.h"
42 #include "cso_cache/cso_context.h"
43 #include "util/u_draw_quad.h"
44 #include "util/u_inlines.h"
45 #include "util/u_memory.h"
46 #include "util/u_math.h"
47 #include "util/u_sampler.h"
48 #include "util/u_simple_shaders.h"
49 #include "util/u_string.h"
50 #include "util/u_upload_mgr.h"
51 #include "tgsi/tgsi_text.h"
52 #include "tgsi/tgsi_dump.h"
56 struct pipe_context
*pipe
;
57 struct cso_context
*cso
;
58 struct u_upload_mgr
*uploader
;
60 struct list_head pane_list
;
63 struct pipe_blend_state alpha_blend
;
64 struct pipe_depth_stencil_alpha_state dsa
;
65 void *fs_color
, *fs_text
;
66 struct pipe_rasterizer_state rasterizer
;
68 struct pipe_vertex_element velems
[2];
71 struct util_font font
;
72 struct pipe_sampler_view
*font_sampler_view
;
73 struct pipe_sampler_state font_sampler_state
;
75 /* VS constant buffer */
78 float two_div_fb_width
;
79 float two_div_fb_height
;
84 struct pipe_constant_buffer constbuf
;
86 unsigned fb_width
, fb_height
;
88 /* vertices for text and background drawing are accumulated here and then
89 * drawn all at once */
92 struct pipe_vertex_buffer vbuf
;
93 unsigned max_num_vertices
;
94 unsigned num_vertices
;
95 } text
, bg
, whitelines
;
100 hud_draw_colored_prims(struct hud_context
*hud
, unsigned prim
,
101 float *buffer
, unsigned num_vertices
,
102 float r
, float g
, float b
, float a
,
103 int xoffset
, int yoffset
, float yscale
)
105 struct cso_context
*cso
= hud
->cso
;
106 struct pipe_vertex_buffer vbuffer
= {0};
108 hud
->constants
.color
[0] = r
;
109 hud
->constants
.color
[1] = g
;
110 hud
->constants
.color
[2] = b
;
111 hud
->constants
.color
[3] = a
;
112 hud
->constants
.translate
[0] = (float) xoffset
;
113 hud
->constants
.translate
[1] = (float) yoffset
;
114 hud
->constants
.scale
[0] = 1;
115 hud
->constants
.scale
[1] = yscale
;
116 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
118 vbuffer
.user_buffer
= buffer
;
119 vbuffer
.stride
= 2 * sizeof(float);
121 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
),
123 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
124 cso_draw_arrays(cso
, prim
, 0, num_vertices
);
128 hud_draw_colored_quad(struct hud_context
*hud
, unsigned prim
,
129 unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
130 float r
, float g
, float b
, float a
)
133 (float) x1
, (float) y1
,
134 (float) x1
, (float) y2
,
135 (float) x2
, (float) y2
,
136 (float) x2
, (float) y1
,
139 hud_draw_colored_prims(hud
, prim
, buffer
, 4, r
, g
, b
, a
, 0, 0, 1);
143 hud_draw_background_quad(struct hud_context
*hud
,
144 unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
)
146 float *vertices
= hud
->bg
.vertices
+ hud
->bg
.num_vertices
*2;
149 assert(hud
->bg
.num_vertices
+ 4 <= hud
->bg
.max_num_vertices
);
151 vertices
[num
++] = (float) x1
;
152 vertices
[num
++] = (float) y1
;
154 vertices
[num
++] = (float) x1
;
155 vertices
[num
++] = (float) y2
;
157 vertices
[num
++] = (float) x2
;
158 vertices
[num
++] = (float) y2
;
160 vertices
[num
++] = (float) x2
;
161 vertices
[num
++] = (float) y1
;
163 hud
->bg
.num_vertices
+= num
/2;
167 hud_draw_string(struct hud_context
*hud
, unsigned x
, unsigned y
,
168 const char *str
, ...)
172 float *vertices
= hud
->text
.vertices
+ hud
->text
.num_vertices
*4;
177 util_vsnprintf(buf
, sizeof(buf
), str
, ap
);
183 hud_draw_background_quad(hud
,
185 x
+ strlen(buf
)*hud
->font
.glyph_width
,
186 y
+ hud
->font
.glyph_height
);
191 unsigned x2
= x
+ hud
->font
.glyph_width
;
192 unsigned y2
= y
+ hud
->font
.glyph_height
;
193 unsigned tx1
= (*s
% 16) * hud
->font
.glyph_width
;
194 unsigned ty1
= (*s
/ 16) * hud
->font
.glyph_height
;
195 unsigned tx2
= tx1
+ hud
->font
.glyph_width
;
196 unsigned ty2
= ty1
+ hud
->font
.glyph_height
;
199 x
+= hud
->font
.glyph_width
;
204 assert(hud
->text
.num_vertices
+ num
/4 + 4 <= hud
->text
.max_num_vertices
);
206 vertices
[num
++] = (float) x1
;
207 vertices
[num
++] = (float) y1
;
208 vertices
[num
++] = (float) tx1
;
209 vertices
[num
++] = (float) ty1
;
211 vertices
[num
++] = (float) x1
;
212 vertices
[num
++] = (float) y2
;
213 vertices
[num
++] = (float) tx1
;
214 vertices
[num
++] = (float) ty2
;
216 vertices
[num
++] = (float) x2
;
217 vertices
[num
++] = (float) y2
;
218 vertices
[num
++] = (float) tx2
;
219 vertices
[num
++] = (float) ty2
;
221 vertices
[num
++] = (float) x2
;
222 vertices
[num
++] = (float) y1
;
223 vertices
[num
++] = (float) tx2
;
224 vertices
[num
++] = (float) ty1
;
226 x
+= hud
->font
.glyph_width
;
230 hud
->text
.num_vertices
+= num
/4;
234 number_to_human_readable(uint64_t num
, enum pipe_driver_query_type type
,
237 static const char *byte_units
[] =
238 {" B", " KB", " MB", " GB", " TB", " PB", " EB"};
239 static const char *metric_units
[] =
240 {"", " k", " M", " G", " T", " P", " E"};
241 static const char *time_units
[] =
242 {" us", " ms", " s"}; /* based on microseconds */
243 static const char *hz_units
[] =
244 {" Hz", " KHz", " MHz", " GHz"};
245 static const char *percent_units
[] = {"%"};
249 double divisor
= (type
== PIPE_DRIVER_QUERY_TYPE_BYTES
) ? 1024 : 1000;
254 case PIPE_DRIVER_QUERY_TYPE_MICROSECONDS
:
255 max_unit
= ARRAY_SIZE(time_units
)-1;
258 case PIPE_DRIVER_QUERY_TYPE_PERCENTAGE
:
259 max_unit
= ARRAY_SIZE(percent_units
)-1;
260 units
= percent_units
;
262 case PIPE_DRIVER_QUERY_TYPE_BYTES
:
263 max_unit
= ARRAY_SIZE(byte_units
)-1;
266 case PIPE_DRIVER_QUERY_TYPE_HZ
:
267 max_unit
= ARRAY_SIZE(hz_units
)-1;
271 max_unit
= ARRAY_SIZE(metric_units
)-1;
272 units
= metric_units
;
275 while (d
> divisor
&& unit
< max_unit
) {
280 if (d
>= 100 || d
== (int)d
)
281 sprintf(out
, "%.0f%s", d
, units
[unit
]);
282 else if (d
>= 10 || d
*10 == (int)(d
*10))
283 sprintf(out
, "%.1f%s", d
, units
[unit
]);
285 sprintf(out
, "%.2f%s", d
, units
[unit
]);
289 hud_draw_graph_line_strip(struct hud_context
*hud
, const struct hud_graph
*gr
,
290 unsigned xoffset
, unsigned yoffset
, float yscale
)
292 if (gr
->num_vertices
<= 1)
295 assert(gr
->index
<= gr
->num_vertices
);
297 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
298 gr
->vertices
, gr
->index
,
299 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
300 xoffset
+ (gr
->pane
->max_num_vertices
- gr
->index
- 1) * 2 - 1,
303 if (gr
->num_vertices
<= gr
->index
)
306 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
307 gr
->vertices
+ gr
->index
*2,
308 gr
->num_vertices
- gr
->index
,
309 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
310 xoffset
- gr
->index
*2 - 1, yoffset
, yscale
);
314 hud_pane_accumulate_vertices(struct hud_context
*hud
,
315 const struct hud_pane
*pane
)
317 struct hud_graph
*gr
;
318 float *line_verts
= hud
->whitelines
.vertices
+ hud
->whitelines
.num_vertices
*2;
322 /* draw background */
323 hud_draw_background_quad(hud
,
327 /* draw numbers on the right-hand side */
328 for (i
= 0; i
< 6; i
++) {
329 unsigned x
= pane
->x2
+ 2;
330 unsigned y
= pane
->inner_y1
+ pane
->inner_height
* (5 - i
) / 5 -
331 hud
->font
.glyph_height
/ 2;
333 number_to_human_readable(pane
->max_value
* i
/ 5,
335 hud_draw_string(hud
, x
, y
, "%s", str
);
338 /* draw info below the pane */
340 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
341 unsigned x
= pane
->x1
+ 2;
342 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
344 number_to_human_readable(gr
->current_value
,
346 hud_draw_string(hud
, x
, y
, " %s: %s", gr
->name
, str
);
351 assert(hud
->whitelines
.num_vertices
+ num
/2 + 8 <= hud
->whitelines
.max_num_vertices
);
352 line_verts
[num
++] = (float) pane
->x1
;
353 line_verts
[num
++] = (float) pane
->y1
;
354 line_verts
[num
++] = (float) pane
->x2
;
355 line_verts
[num
++] = (float) pane
->y1
;
357 line_verts
[num
++] = (float) pane
->x2
;
358 line_verts
[num
++] = (float) pane
->y1
;
359 line_verts
[num
++] = (float) pane
->x2
;
360 line_verts
[num
++] = (float) pane
->y2
;
362 line_verts
[num
++] = (float) pane
->x1
;
363 line_verts
[num
++] = (float) pane
->y2
;
364 line_verts
[num
++] = (float) pane
->x2
;
365 line_verts
[num
++] = (float) pane
->y2
;
367 line_verts
[num
++] = (float) pane
->x1
;
368 line_verts
[num
++] = (float) pane
->y1
;
369 line_verts
[num
++] = (float) pane
->x1
;
370 line_verts
[num
++] = (float) pane
->y2
;
372 /* draw horizontal lines inside the graph */
373 for (i
= 0; i
<= 5; i
++) {
374 float y
= round((pane
->max_value
* i
/ 5.0) * pane
->yscale
+ pane
->inner_y2
);
376 assert(hud
->whitelines
.num_vertices
+ num
/2 + 2 <= hud
->whitelines
.max_num_vertices
);
377 line_verts
[num
++] = pane
->x1
;
378 line_verts
[num
++] = y
;
379 line_verts
[num
++] = pane
->x2
;
380 line_verts
[num
++] = y
;
383 hud
->whitelines
.num_vertices
+= num
/2;
387 hud_pane_draw_colored_objects(struct hud_context
*hud
,
388 const struct hud_pane
*pane
)
390 struct hud_graph
*gr
;
393 /* draw colored quads below the pane */
395 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
396 unsigned x
= pane
->x1
+ 2;
397 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
399 hud_draw_colored_quad(hud
, PIPE_PRIM_QUADS
, x
+ 1, y
+ 1, x
+ 12, y
+ 13,
400 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1);
404 /* draw the line strips */
405 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
406 hud_draw_graph_line_strip(hud
, gr
, pane
->inner_x1
, pane
->inner_y2
, pane
->yscale
);
411 hud_alloc_vertices(struct hud_context
*hud
, struct vertex_queue
*v
,
412 unsigned num_vertices
, unsigned stride
)
415 v
->max_num_vertices
= num_vertices
;
416 v
->vbuf
.stride
= stride
;
417 u_upload_alloc(hud
->uploader
, 0, v
->vbuf
.stride
* v
->max_num_vertices
,
418 &v
->vbuf
.buffer_offset
, &v
->vbuf
.buffer
,
419 (void**)&v
->vertices
);
423 * Draw the HUD to the texture \p tex.
424 * The texture is usually the back buffer being displayed.
427 hud_draw(struct hud_context
*hud
, struct pipe_resource
*tex
)
429 struct cso_context
*cso
= hud
->cso
;
430 struct pipe_context
*pipe
= hud
->pipe
;
431 struct pipe_framebuffer_state fb
;
432 struct pipe_surface surf_templ
, *surf
;
433 struct pipe_viewport_state viewport
;
434 const struct pipe_sampler_state
*sampler_states
[] =
435 { &hud
->font_sampler_state
};
436 struct hud_pane
*pane
;
437 struct hud_graph
*gr
;
439 hud
->fb_width
= tex
->width0
;
440 hud
->fb_height
= tex
->height0
;
441 hud
->constants
.two_div_fb_width
= 2.0f
/ hud
->fb_width
;
442 hud
->constants
.two_div_fb_height
= 2.0f
/ hud
->fb_height
;
444 cso_save_framebuffer(cso
);
445 cso_save_sample_mask(cso
);
446 cso_save_min_samples(cso
);
448 cso_save_depth_stencil_alpha(cso
);
449 cso_save_fragment_shader(cso
);
450 cso_save_fragment_sampler_views(cso
);
451 cso_save_fragment_samplers(cso
);
452 cso_save_rasterizer(cso
);
453 cso_save_viewport(cso
);
454 cso_save_stream_outputs(cso
);
455 cso_save_geometry_shader(cso
);
456 cso_save_tessctrl_shader(cso
);
457 cso_save_tesseval_shader(cso
);
458 cso_save_vertex_shader(cso
);
459 cso_save_vertex_elements(cso
);
460 cso_save_aux_vertex_buffer_slot(cso
);
461 cso_save_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
462 cso_save_render_condition(cso
);
465 memset(&surf_templ
, 0, sizeof(surf_templ
));
466 surf_templ
.format
= tex
->format
;
467 surf
= pipe
->create_surface(pipe
, tex
, &surf_templ
);
469 memset(&fb
, 0, sizeof(fb
));
473 fb
.width
= hud
->fb_width
;
474 fb
.height
= hud
->fb_height
;
476 viewport
.scale
[0] = 0.5f
* hud
->fb_width
;
477 viewport
.scale
[1] = 0.5f
* hud
->fb_height
;
478 viewport
.scale
[2] = 1.0f
;
479 viewport
.translate
[0] = 0.5f
* hud
->fb_width
;
480 viewport
.translate
[1] = 0.5f
* hud
->fb_height
;
481 viewport
.translate
[2] = 0.0f
;
483 cso_set_framebuffer(cso
, &fb
);
484 cso_set_sample_mask(cso
, ~0);
485 cso_set_min_samples(cso
, 1);
486 cso_set_blend(cso
, &hud
->alpha_blend
);
487 cso_set_depth_stencil_alpha(cso
, &hud
->dsa
);
488 cso_set_rasterizer(cso
, &hud
->rasterizer
);
489 cso_set_viewport(cso
, &viewport
);
490 cso_set_stream_outputs(cso
, 0, NULL
, NULL
);
491 cso_set_tessctrl_shader_handle(cso
, NULL
);
492 cso_set_tesseval_shader_handle(cso
, NULL
);
493 cso_set_geometry_shader_handle(cso
, NULL
);
494 cso_set_vertex_shader_handle(cso
, hud
->vs
);
495 cso_set_vertex_elements(cso
, 2, hud
->velems
);
496 cso_set_render_condition(cso
, NULL
, FALSE
, 0);
497 cso_set_sampler_views(cso
, PIPE_SHADER_FRAGMENT
, 1,
498 &hud
->font_sampler_view
);
499 cso_set_samplers(cso
, PIPE_SHADER_FRAGMENT
, 1, sampler_states
);
500 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
502 /* prepare vertex buffers */
503 hud_alloc_vertices(hud
, &hud
->bg
, 4 * 128, 2 * sizeof(float));
504 hud_alloc_vertices(hud
, &hud
->whitelines
, 4 * 256, 2 * sizeof(float));
505 hud_alloc_vertices(hud
, &hud
->text
, 4 * 512, 4 * sizeof(float));
507 /* prepare all graphs */
508 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
509 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
510 gr
->query_new_value(gr
);
513 hud_pane_accumulate_vertices(hud
, pane
);
516 /* unmap the uploader's vertex buffer before drawing */
517 u_upload_unmap(hud
->uploader
);
519 /* draw accumulated vertices for background quads */
520 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
522 if (hud
->bg
.num_vertices
) {
523 hud
->constants
.color
[0] = 0;
524 hud
->constants
.color
[1] = 0;
525 hud
->constants
.color
[2] = 0;
526 hud
->constants
.color
[3] = 0.666f
;
527 hud
->constants
.translate
[0] = 0;
528 hud
->constants
.translate
[1] = 0;
529 hud
->constants
.scale
[0] = 1;
530 hud
->constants
.scale
[1] = 1;
532 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
533 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
535 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->bg
.num_vertices
);
537 pipe_resource_reference(&hud
->bg
.vbuf
.buffer
, NULL
);
539 /* draw accumulated vertices for white lines */
540 hud
->constants
.color
[0] = 1;
541 hud
->constants
.color
[1] = 1;
542 hud
->constants
.color
[2] = 1;
543 hud
->constants
.color
[3] = 1;
544 hud
->constants
.translate
[0] = 0;
545 hud
->constants
.translate
[1] = 0;
546 hud
->constants
.scale
[0] = 1;
547 hud
->constants
.scale
[1] = 1;
548 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
550 if (hud
->whitelines
.num_vertices
) {
551 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
552 &hud
->whitelines
.vbuf
);
553 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
554 cso_draw_arrays(cso
, PIPE_PRIM_LINES
, 0, hud
->whitelines
.num_vertices
);
556 pipe_resource_reference(&hud
->whitelines
.vbuf
.buffer
, NULL
);
558 /* draw accumulated vertices for text */
559 if (hud
->text
.num_vertices
) {
560 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
562 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_text
);
563 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->text
.num_vertices
);
565 pipe_resource_reference(&hud
->text
.vbuf
.buffer
, NULL
);
568 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
570 hud_pane_draw_colored_objects(hud
, pane
);
574 cso_restore_framebuffer(cso
);
575 cso_restore_sample_mask(cso
);
576 cso_restore_min_samples(cso
);
577 cso_restore_blend(cso
);
578 cso_restore_depth_stencil_alpha(cso
);
579 cso_restore_fragment_shader(cso
);
580 cso_restore_fragment_sampler_views(cso
);
581 cso_restore_fragment_samplers(cso
);
582 cso_restore_rasterizer(cso
);
583 cso_restore_viewport(cso
);
584 cso_restore_stream_outputs(cso
);
585 cso_restore_tessctrl_shader(cso
);
586 cso_restore_tesseval_shader(cso
);
587 cso_restore_geometry_shader(cso
);
588 cso_restore_vertex_shader(cso
);
589 cso_restore_vertex_elements(cso
);
590 cso_restore_aux_vertex_buffer_slot(cso
);
591 cso_restore_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
592 cso_restore_render_condition(cso
);
594 pipe_surface_reference(&surf
, NULL
);
598 * Set the maximum value for the Y axis of the graph.
599 * This scales the graph accordingly.
602 hud_pane_set_max_value(struct hud_pane
*pane
, uint64_t value
)
604 pane
->max_value
= value
;
605 pane
->yscale
= -(int)pane
->inner_height
/ (float)pane
->max_value
;
609 hud_pane_update_dyn_ceiling(struct hud_graph
*gr
, struct hud_pane
*pane
)
614 if (pane
->dyn_ceil_last_ran
!= gr
->index
) {
615 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
616 for (i
= 0; i
< gr
->num_vertices
; ++i
) {
617 tmp
= gr
->vertices
[i
* 2 + 1] > tmp
?
618 gr
->vertices
[i
* 2 + 1] : tmp
;
622 /* Avoid setting it lower than the initial starting height. */
623 tmp
= tmp
> pane
->initial_max_value
? tmp
: pane
->initial_max_value
;
624 hud_pane_set_max_value(pane
, tmp
);
628 * Mark this adjustment run so we could avoid repeating a full update
629 * again needlessly in case the pane has more than one graph.
631 pane
->dyn_ceil_last_ran
= gr
->index
;
634 static struct hud_pane
*
635 hud_pane_create(unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
636 unsigned period
, uint64_t max_value
, uint64_t ceiling
,
639 struct hud_pane
*pane
= CALLOC_STRUCT(hud_pane
);
648 pane
->inner_x1
= x1
+ 1;
649 pane
->inner_x2
= x2
- 1;
650 pane
->inner_y1
= y1
+ 1;
651 pane
->inner_y2
= y2
- 1;
652 pane
->inner_width
= pane
->inner_x2
- pane
->inner_x1
;
653 pane
->inner_height
= pane
->inner_y2
- pane
->inner_y1
;
654 pane
->period
= period
;
655 pane
->max_num_vertices
= (x2
- x1
+ 2) / 2;
656 pane
->ceiling
= ceiling
;
657 pane
->dyn_ceiling
= dyn_ceiling
;
658 pane
->dyn_ceil_last_ran
= 0;
659 pane
->initial_max_value
= max_value
;
660 hud_pane_set_max_value(pane
, max_value
);
661 LIST_INITHEAD(&pane
->graph_list
);
666 * Add a graph to an existing pane.
667 * One pane can contain multiple graphs over each other.
670 hud_pane_add_graph(struct hud_pane
*pane
, struct hud_graph
*gr
)
672 static const float colors
[][3] = {
681 char *name
= gr
->name
;
683 /* replace '-' with a space */
690 assert(pane
->num_graphs
< Elements(colors
));
691 gr
->vertices
= MALLOC(pane
->max_num_vertices
* sizeof(float) * 2);
692 gr
->color
[0] = colors
[pane
->num_graphs
][0];
693 gr
->color
[1] = colors
[pane
->num_graphs
][1];
694 gr
->color
[2] = colors
[pane
->num_graphs
][2];
696 LIST_ADDTAIL(&gr
->head
, &pane
->graph_list
);
701 hud_graph_add_value(struct hud_graph
*gr
, uint64_t value
)
703 gr
->current_value
= value
;
704 value
= value
> gr
->pane
->ceiling
? gr
->pane
->ceiling
: value
;
706 if (gr
->index
== gr
->pane
->max_num_vertices
) {
708 gr
->vertices
[1] = gr
->vertices
[(gr
->index
-1)*2+1];
711 gr
->vertices
[(gr
->index
)*2+0] = (float) (gr
->index
* 2);
712 gr
->vertices
[(gr
->index
)*2+1] = (float) value
;
715 if (gr
->num_vertices
< gr
->pane
->max_num_vertices
) {
719 if (gr
->pane
->dyn_ceiling
== true) {
720 hud_pane_update_dyn_ceiling(gr
, gr
->pane
);
722 if (value
> gr
->pane
->max_value
) {
723 hud_pane_set_max_value(gr
->pane
, value
);
728 hud_graph_destroy(struct hud_graph
*graph
)
730 FREE(graph
->vertices
);
731 if (graph
->free_query_data
)
732 graph
->free_query_data(graph
->query_data
);
737 * Read a string from the environment variable.
738 * The separators "+", ",", ":", and ";" terminate the string.
739 * Return the number of read characters.
742 parse_string(const char *s
, char *out
)
746 for (i
= 0; *s
&& *s
!= '+' && *s
!= ',' && *s
!= ':' && *s
!= ';';
753 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) while "
754 "parsing a string\n", *s
, *s
);
759 read_pane_settings(char *str
, unsigned * const x
, unsigned * const y
,
760 unsigned * const width
, unsigned * const height
,
761 uint64_t * const ceiling
, boolean
* const dyn_ceiling
)
766 while (*str
== '.') {
771 *x
= strtoul(str
, &ret
, 10);
777 *y
= strtoul(str
, &ret
, 10);
783 tmp
= strtoul(str
, &ret
, 10);
784 *width
= tmp
> 80 ? tmp
: 80; /* 80 is chosen arbitrarily */
789 * Prevent setting height to less than 50. If the height is set to less,
790 * the text of the Y axis labels on the graph will start overlapping.
794 tmp
= strtoul(str
, &ret
, 10);
795 *height
= tmp
> 50 ? tmp
: 50;
801 tmp
= strtoul(str
, &ret
, 10);
802 *ceiling
= tmp
> 10 ? tmp
: 10;
813 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c'\n", *str
);
822 has_occlusion_query(struct pipe_screen
*screen
)
824 return screen
->get_param(screen
, PIPE_CAP_OCCLUSION_QUERY
) != 0;
828 has_streamout(struct pipe_screen
*screen
)
830 return screen
->get_param(screen
, PIPE_CAP_MAX_STREAM_OUTPUT_BUFFERS
) != 0;
834 has_pipeline_stats_query(struct pipe_screen
*screen
)
836 return screen
->get_param(screen
, PIPE_CAP_QUERY_PIPELINE_STATISTICS
) != 0;
840 hud_parse_env_var(struct hud_context
*hud
, const char *env
)
843 char name_a
[256], s
[256];
845 struct hud_pane
*pane
= NULL
;
846 unsigned x
= 10, y
= 10;
847 unsigned width
= 251, height
= 100;
848 unsigned period
= 500 * 1000; /* default period (1/2 second) */
849 uint64_t ceiling
= UINT64_MAX
;
850 unsigned column_width
= 251;
851 boolean dyn_ceiling
= false;
852 const char *period_env
;
855 * The GALLIUM_HUD_PERIOD env var sets the graph update rate.
856 * The env var is in seconds (a float).
857 * Zero means update after every frame.
859 period_env
= getenv("GALLIUM_HUD_PERIOD");
861 float p
= (float) atof(period_env
);
863 period
= (unsigned) (p
* 1000 * 1000);
867 while ((num
= parse_string(env
, name_a
)) != 0) {
870 /* check for explicit location, size and etc. settings */
871 name
= read_pane_settings(name_a
, &x
, &y
, &width
, &height
, &ceiling
,
875 * Keep track of overall column width to avoid pane overlapping in case
876 * later we create a new column while the bottom pane in the current
877 * column is less wide than the rest of the panes in it.
879 column_width
= width
> column_width
? width
: column_width
;
882 pane
= hud_pane_create(x
, y
, x
+ width
, y
+ height
, period
, 10,
883 ceiling
, dyn_ceiling
);
889 /* IF YOU CHANGE THIS, UPDATE print_help! */
890 if (strcmp(name
, "fps") == 0) {
891 hud_fps_graph_install(pane
);
893 else if (strcmp(name
, "cpu") == 0) {
894 hud_cpu_graph_install(pane
, ALL_CPUS
);
896 else if (sscanf(name
, "cpu%u%s", &i
, s
) == 1) {
897 hud_cpu_graph_install(pane
, i
);
899 else if (strcmp(name
, "samples-passed") == 0 &&
900 has_occlusion_query(hud
->pipe
->screen
)) {
901 hud_pipe_query_install(pane
, hud
->pipe
, "samples-passed",
902 PIPE_QUERY_OCCLUSION_COUNTER
, 0, 0,
903 PIPE_DRIVER_QUERY_TYPE_UINT64
,
904 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
);
906 else if (strcmp(name
, "primitives-generated") == 0 &&
907 has_streamout(hud
->pipe
->screen
)) {
908 hud_pipe_query_install(pane
, hud
->pipe
, "primitives-generated",
909 PIPE_QUERY_PRIMITIVES_GENERATED
, 0, 0,
910 PIPE_DRIVER_QUERY_TYPE_UINT64
,
911 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
);
914 boolean processed
= FALSE
;
916 /* pipeline statistics queries */
917 if (has_pipeline_stats_query(hud
->pipe
->screen
)) {
918 static const char *pipeline_statistics_names
[] =
925 "clipper-invocations",
926 "clipper-primitives-generated",
932 for (i
= 0; i
< Elements(pipeline_statistics_names
); ++i
)
933 if (strcmp(name
, pipeline_statistics_names
[i
]) == 0)
935 if (i
< Elements(pipeline_statistics_names
)) {
936 hud_pipe_query_install(pane
, hud
->pipe
, name
,
937 PIPE_QUERY_PIPELINE_STATISTICS
, i
,
938 0, PIPE_DRIVER_QUERY_TYPE_UINT64
,
939 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
);
946 if (!hud_driver_query_install(pane
, hud
->pipe
, name
)){
947 fprintf(stderr
, "gallium_hud: unknown driver query '%s'\n", name
);
956 fprintf(stderr
, "gallium_hud: syntax error: unexpected ':', "
957 "expected a name\n");
961 num
= parse_string(env
, s
);
964 if (num
&& sscanf(s
, "%u", &i
) == 1) {
965 hud_pane_set_max_value(pane
, i
);
966 pane
->initial_max_value
= i
;
969 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) "
970 "after ':'\n", *env
, *env
);
977 /* parse a separator */
985 y
+= height
+ hud
->font
.glyph_height
* (pane
->num_graphs
+ 2);
988 if (pane
&& pane
->num_graphs
) {
989 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
997 x
+= column_width
+ hud
->font
.glyph_width
* 7;
1000 if (pane
&& pane
->num_graphs
) {
1001 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
1005 /* Starting a new column; reset column width. */
1010 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c'\n", *env
);
1013 /* Reset to defaults for the next pane in case these were modified. */
1015 ceiling
= UINT64_MAX
;
1016 dyn_ceiling
= false;
1021 if (pane
->num_graphs
) {
1022 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
1031 print_help(struct pipe_screen
*screen
)
1033 int i
, num_queries
, num_cpus
= hud_get_num_cpus();
1035 puts("Syntax: GALLIUM_HUD=name1[+name2][...][:value1][,nameI...][;nameJ...]");
1037 puts(" Names are identifiers of data sources which will be drawn as graphs");
1038 puts(" in panes. Multiple graphs can be drawn in the same pane.");
1039 puts(" There can be multiple panes placed in rows and columns.");
1041 puts(" '+' separates names which will share a pane.");
1042 puts(" ':[value]' specifies the initial maximum value of the Y axis");
1043 puts(" for the given pane.");
1044 puts(" ',' creates a new pane below the last one.");
1045 puts(" ';' creates a new pane at the top of the next column.");
1047 puts(" Example: GALLIUM_HUD=\"cpu,fps;primitives-generated\"");
1049 puts(" Additionally, by prepending '.[identifier][value]' modifiers to");
1050 puts(" a name, it is possible to explicitly set the location and size");
1051 puts(" of a pane, along with limiting overall maximum value of the");
1052 puts(" Y axis and activating dynamic readjustment of the Y axis.");
1053 puts(" Several modifiers may be applied to the same pane simultaneously.");
1055 puts(" 'x[value]' sets the location of the pane on the x axis relative");
1056 puts(" to the upper-left corner of the viewport, in pixels.");
1057 puts(" 'y[value]' sets the location of the pane on the y axis relative");
1058 puts(" to the upper-left corner of the viewport, in pixels.");
1059 puts(" 'w[value]' sets width of the graph pixels.");
1060 puts(" 'h[value]' sets height of the graph in pixels.");
1061 puts(" 'c[value]' sets the ceiling of the value of the Y axis.");
1062 puts(" If the graph needs to draw values higher than");
1063 puts(" the ceiling allows, the value is clamped.");
1064 puts(" 'd' activates dynamic Y axis readjustment to set the value of");
1065 puts(" the Y axis to match the highest value still visible in the graph.");
1067 puts(" If 'c' and 'd' modifiers are used simultaneously, both are in effect:");
1068 puts(" the Y axis does not go above the restriction imposed by 'c' while");
1069 puts(" still adjusting the value of the Y axis down when appropriate.");
1071 puts(" Example: GALLIUM_HUD=\".w256.h64.x1600.y520.d.c1000fps+cpu,.datom-count\"");
1073 puts(" Available names:");
1077 for (i
= 0; i
< num_cpus
; i
++)
1078 printf(" cpu%i\n", i
);
1080 if (has_occlusion_query(screen
))
1081 puts(" samples-passed");
1082 if (has_streamout(screen
))
1083 puts(" primitives-generated");
1085 if (has_pipeline_stats_query(screen
)) {
1086 puts(" ia-vertices");
1087 puts(" ia-primitives");
1088 puts(" vs-invocations");
1089 puts(" gs-invocations");
1090 puts(" gs-primitives");
1091 puts(" clipper-invocations");
1092 puts(" clipper-primitives-generated");
1093 puts(" ps-invocations");
1094 puts(" hs-invocations");
1095 puts(" ds-invocations");
1096 puts(" cs-invocations");
1099 if (screen
->get_driver_query_info
){
1100 struct pipe_driver_query_info info
;
1101 num_queries
= screen
->get_driver_query_info(screen
, 0, NULL
);
1103 for (i
= 0; i
< num_queries
; i
++){
1104 screen
->get_driver_query_info(screen
, i
, &info
);
1105 printf(" %s\n", info
.name
);
1113 struct hud_context
*
1114 hud_create(struct pipe_context
*pipe
, struct cso_context
*cso
)
1116 struct hud_context
*hud
;
1117 struct pipe_sampler_view view_templ
;
1119 const char *env
= debug_get_option("GALLIUM_HUD", NULL
);
1124 if (strcmp(env
, "help") == 0) {
1125 print_help(pipe
->screen
);
1129 hud
= CALLOC_STRUCT(hud_context
);
1135 hud
->uploader
= u_upload_create(pipe
, 256 * 1024, 16,
1136 PIPE_BIND_VERTEX_BUFFER
);
1139 if (!util_font_create(pipe
, UTIL_FONT_FIXED_8X13
, &hud
->font
)) {
1140 u_upload_destroy(hud
->uploader
);
1146 hud
->alpha_blend
.rt
[0].colormask
= PIPE_MASK_RGBA
;
1147 hud
->alpha_blend
.rt
[0].blend_enable
= 1;
1148 hud
->alpha_blend
.rt
[0].rgb_func
= PIPE_BLEND_ADD
;
1149 hud
->alpha_blend
.rt
[0].rgb_src_factor
= PIPE_BLENDFACTOR_SRC_ALPHA
;
1150 hud
->alpha_blend
.rt
[0].rgb_dst_factor
= PIPE_BLENDFACTOR_INV_SRC_ALPHA
;
1151 hud
->alpha_blend
.rt
[0].alpha_func
= PIPE_BLEND_ADD
;
1152 hud
->alpha_blend
.rt
[0].alpha_src_factor
= PIPE_BLENDFACTOR_ZERO
;
1153 hud
->alpha_blend
.rt
[0].alpha_dst_factor
= PIPE_BLENDFACTOR_ONE
;
1155 /* fragment shader */
1157 util_make_fragment_passthrough_shader(pipe
,
1158 TGSI_SEMANTIC_COLOR
,
1159 TGSI_INTERPOLATE_CONSTANT
,
1163 /* Read a texture and do .xxxx swizzling. */
1164 static const char *fragment_shader_text
= {
1166 "DCL IN[0], GENERIC[0], LINEAR\n"
1168 "DCL OUT[0], COLOR[0]\n"
1171 "TEX TEMP[0], IN[0], SAMP[0], RECT\n"
1172 "MOV OUT[0], TEMP[0].xxxx\n"
1176 struct tgsi_token tokens
[1000];
1177 struct pipe_shader_state state
= {tokens
};
1179 if (!tgsi_text_translate(fragment_shader_text
, tokens
, Elements(tokens
))) {
1181 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1182 u_upload_destroy(hud
->uploader
);
1187 hud
->fs_text
= pipe
->create_fs_state(pipe
, &state
);
1191 hud
->rasterizer
.half_pixel_center
= 1;
1192 hud
->rasterizer
.bottom_edge_rule
= 1;
1193 hud
->rasterizer
.depth_clip
= 1;
1194 hud
->rasterizer
.line_width
= 1;
1195 hud
->rasterizer
.line_last_pixel
= 1;
1199 static const char *vertex_shader_text
= {
1202 "DCL OUT[0], POSITION\n"
1203 "DCL OUT[1], COLOR[0]\n" /* color */
1204 "DCL OUT[2], GENERIC[0]\n" /* texcoord */
1206 * [1] = (2/fb_width, 2/fb_height, xoffset, yoffset)
1207 * [2] = (xscale, yscale, 0, 0) */
1210 "IMM[0] FLT32 { -1, 0, 0, 1 }\n"
1212 /* v = in * (xscale, yscale) + (xoffset, yoffset) */
1213 "MAD TEMP[0].xy, IN[0], CONST[2].xyyy, CONST[1].zwww\n"
1214 /* pos = v * (2 / fb_width, 2 / fb_height) - (1, 1) */
1215 "MAD OUT[0].xy, TEMP[0], CONST[1].xyyy, IMM[0].xxxx\n"
1216 "MOV OUT[0].zw, IMM[0]\n"
1218 "MOV OUT[1], CONST[0]\n"
1219 "MOV OUT[2], IN[1]\n"
1223 struct tgsi_token tokens
[1000];
1224 struct pipe_shader_state state
= {tokens
};
1226 if (!tgsi_text_translate(vertex_shader_text
, tokens
, Elements(tokens
))) {
1228 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1229 u_upload_destroy(hud
->uploader
);
1234 hud
->vs
= pipe
->create_vs_state(pipe
, &state
);
1237 /* vertex elements */
1238 for (i
= 0; i
< 2; i
++) {
1239 hud
->velems
[i
].src_offset
= i
* 2 * sizeof(float);
1240 hud
->velems
[i
].src_format
= PIPE_FORMAT_R32G32_FLOAT
;
1241 hud
->velems
[i
].vertex_buffer_index
= cso_get_aux_vertex_buffer_slot(cso
);
1245 u_sampler_view_default_template(
1246 &view_templ
, hud
->font
.texture
, hud
->font
.texture
->format
);
1247 hud
->font_sampler_view
= pipe
->create_sampler_view(pipe
, hud
->font
.texture
,
1250 /* sampler state (for font drawing) */
1251 hud
->font_sampler_state
.wrap_s
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1252 hud
->font_sampler_state
.wrap_t
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1253 hud
->font_sampler_state
.wrap_r
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1254 hud
->font_sampler_state
.normalized_coords
= 0;
1257 hud
->constbuf
.buffer_size
= sizeof(hud
->constants
);
1258 hud
->constbuf
.user_buffer
= &hud
->constants
;
1260 LIST_INITHEAD(&hud
->pane_list
);
1262 hud_parse_env_var(hud
, env
);
1267 hud_destroy(struct hud_context
*hud
)
1269 struct pipe_context
*pipe
= hud
->pipe
;
1270 struct hud_pane
*pane
, *pane_tmp
;
1271 struct hud_graph
*graph
, *graph_tmp
;
1273 LIST_FOR_EACH_ENTRY_SAFE(pane
, pane_tmp
, &hud
->pane_list
, head
) {
1274 LIST_FOR_EACH_ENTRY_SAFE(graph
, graph_tmp
, &pane
->graph_list
, head
) {
1275 LIST_DEL(&graph
->head
);
1276 hud_graph_destroy(graph
);
1278 LIST_DEL(&pane
->head
);
1282 pipe
->delete_fs_state(pipe
, hud
->fs_color
);
1283 pipe
->delete_fs_state(pipe
, hud
->fs_text
);
1284 pipe
->delete_vs_state(pipe
, hud
->vs
);
1285 pipe_sampler_view_reference(&hud
->font_sampler_view
, NULL
);
1286 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1287 u_upload_destroy(hud
->uploader
);