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"};
246 double divisor
= (type
== PIPE_DRIVER_QUERY_TYPE_BYTES
) ? 1024 : 1000;
250 while (d
> divisor
) {
256 case PIPE_DRIVER_QUERY_TYPE_MICROSECONDS
:
257 assert(unit
< ARRAY_SIZE(time_units
));
258 suffix
= time_units
[unit
];
260 case PIPE_DRIVER_QUERY_TYPE_PERCENTAGE
:
263 case PIPE_DRIVER_QUERY_TYPE_BYTES
:
264 assert(unit
< ARRAY_SIZE(byte_units
));
265 suffix
= byte_units
[unit
];
267 case PIPE_DRIVER_QUERY_TYPE_HZ
:
268 assert(unit
< ARRAY_SIZE(hz_units
));
269 suffix
= hz_units
[unit
];
272 assert(unit
< ARRAY_SIZE(metric_units
));
273 suffix
= metric_units
[unit
];
276 if (d
>= 100 || d
== (int)d
)
277 sprintf(out
, "%.0f%s", d
, suffix
);
278 else if (d
>= 10 || d
*10 == (int)(d
*10))
279 sprintf(out
, "%.1f%s", d
, suffix
);
281 sprintf(out
, "%.2f%s", d
, suffix
);
285 hud_draw_graph_line_strip(struct hud_context
*hud
, const struct hud_graph
*gr
,
286 unsigned xoffset
, unsigned yoffset
, float yscale
)
288 if (gr
->num_vertices
<= 1)
291 assert(gr
->index
<= gr
->num_vertices
);
293 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
294 gr
->vertices
, gr
->index
,
295 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
296 xoffset
+ (gr
->pane
->max_num_vertices
- gr
->index
- 1) * 2 - 1,
299 if (gr
->num_vertices
<= gr
->index
)
302 hud_draw_colored_prims(hud
, PIPE_PRIM_LINE_STRIP
,
303 gr
->vertices
+ gr
->index
*2,
304 gr
->num_vertices
- gr
->index
,
305 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1,
306 xoffset
- gr
->index
*2 - 1, yoffset
, yscale
);
310 hud_pane_accumulate_vertices(struct hud_context
*hud
,
311 const struct hud_pane
*pane
)
313 struct hud_graph
*gr
;
314 float *line_verts
= hud
->whitelines
.vertices
+ hud
->whitelines
.num_vertices
*2;
318 /* draw background */
319 hud_draw_background_quad(hud
,
323 /* draw numbers on the right-hand side */
324 for (i
= 0; i
< 6; i
++) {
325 unsigned x
= pane
->x2
+ 2;
326 unsigned y
= pane
->inner_y1
+ pane
->inner_height
* (5 - i
) / 5 -
327 hud
->font
.glyph_height
/ 2;
329 number_to_human_readable(pane
->max_value
* i
/ 5,
331 hud_draw_string(hud
, x
, y
, str
);
334 /* draw info below the pane */
336 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
337 unsigned x
= pane
->x1
+ 2;
338 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
340 number_to_human_readable(gr
->current_value
,
342 hud_draw_string(hud
, x
, y
, " %s: %s", gr
->name
, str
);
347 assert(hud
->whitelines
.num_vertices
+ num
/2 + 8 <= hud
->whitelines
.max_num_vertices
);
348 line_verts
[num
++] = (float) pane
->x1
;
349 line_verts
[num
++] = (float) pane
->y1
;
350 line_verts
[num
++] = (float) pane
->x2
;
351 line_verts
[num
++] = (float) pane
->y1
;
353 line_verts
[num
++] = (float) pane
->x2
;
354 line_verts
[num
++] = (float) pane
->y1
;
355 line_verts
[num
++] = (float) pane
->x2
;
356 line_verts
[num
++] = (float) pane
->y2
;
358 line_verts
[num
++] = (float) pane
->x1
;
359 line_verts
[num
++] = (float) pane
->y2
;
360 line_verts
[num
++] = (float) pane
->x2
;
361 line_verts
[num
++] = (float) pane
->y2
;
363 line_verts
[num
++] = (float) pane
->x1
;
364 line_verts
[num
++] = (float) pane
->y1
;
365 line_verts
[num
++] = (float) pane
->x1
;
366 line_verts
[num
++] = (float) pane
->y2
;
368 /* draw horizontal lines inside the graph */
369 for (i
= 0; i
<= 5; i
++) {
370 float y
= round((pane
->max_value
* i
/ 5.0) * pane
->yscale
+ pane
->inner_y2
);
372 assert(hud
->whitelines
.num_vertices
+ num
/2 + 2 <= hud
->whitelines
.max_num_vertices
);
373 line_verts
[num
++] = pane
->x1
;
374 line_verts
[num
++] = y
;
375 line_verts
[num
++] = pane
->x2
;
376 line_verts
[num
++] = y
;
379 hud
->whitelines
.num_vertices
+= num
/2;
383 hud_pane_draw_colored_objects(struct hud_context
*hud
,
384 const struct hud_pane
*pane
)
386 struct hud_graph
*gr
;
389 /* draw colored quads below the pane */
391 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
392 unsigned x
= pane
->x1
+ 2;
393 unsigned y
= pane
->y2
+ 2 + i
*hud
->font
.glyph_height
;
395 hud_draw_colored_quad(hud
, PIPE_PRIM_QUADS
, x
+ 1, y
+ 1, x
+ 12, y
+ 13,
396 gr
->color
[0], gr
->color
[1], gr
->color
[2], 1);
400 /* draw the line strips */
401 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
402 hud_draw_graph_line_strip(hud
, gr
, pane
->inner_x1
, pane
->inner_y2
, pane
->yscale
);
407 hud_alloc_vertices(struct hud_context
*hud
, struct vertex_queue
*v
,
408 unsigned num_vertices
, unsigned stride
)
411 v
->max_num_vertices
= num_vertices
;
412 v
->vbuf
.stride
= stride
;
413 u_upload_alloc(hud
->uploader
, 0, v
->vbuf
.stride
* v
->max_num_vertices
,
414 &v
->vbuf
.buffer_offset
, &v
->vbuf
.buffer
,
415 (void**)&v
->vertices
);
419 * Draw the HUD to the texture \p tex.
420 * The texture is usually the back buffer being displayed.
423 hud_draw(struct hud_context
*hud
, struct pipe_resource
*tex
)
425 struct cso_context
*cso
= hud
->cso
;
426 struct pipe_context
*pipe
= hud
->pipe
;
427 struct pipe_framebuffer_state fb
;
428 struct pipe_surface surf_templ
, *surf
;
429 struct pipe_viewport_state viewport
;
430 const struct pipe_sampler_state
*sampler_states
[] =
431 { &hud
->font_sampler_state
};
432 struct hud_pane
*pane
;
433 struct hud_graph
*gr
;
435 hud
->fb_width
= tex
->width0
;
436 hud
->fb_height
= tex
->height0
;
437 hud
->constants
.two_div_fb_width
= 2.0f
/ hud
->fb_width
;
438 hud
->constants
.two_div_fb_height
= 2.0f
/ hud
->fb_height
;
440 cso_save_framebuffer(cso
);
441 cso_save_sample_mask(cso
);
442 cso_save_min_samples(cso
);
444 cso_save_depth_stencil_alpha(cso
);
445 cso_save_fragment_shader(cso
);
446 cso_save_fragment_sampler_views(cso
);
447 cso_save_fragment_samplers(cso
);
448 cso_save_rasterizer(cso
);
449 cso_save_viewport(cso
);
450 cso_save_stream_outputs(cso
);
451 cso_save_geometry_shader(cso
);
452 cso_save_tessctrl_shader(cso
);
453 cso_save_tesseval_shader(cso
);
454 cso_save_vertex_shader(cso
);
455 cso_save_vertex_elements(cso
);
456 cso_save_aux_vertex_buffer_slot(cso
);
457 cso_save_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
458 cso_save_render_condition(cso
);
461 memset(&surf_templ
, 0, sizeof(surf_templ
));
462 surf_templ
.format
= tex
->format
;
463 surf
= pipe
->create_surface(pipe
, tex
, &surf_templ
);
465 memset(&fb
, 0, sizeof(fb
));
469 fb
.width
= hud
->fb_width
;
470 fb
.height
= hud
->fb_height
;
472 viewport
.scale
[0] = 0.5f
* hud
->fb_width
;
473 viewport
.scale
[1] = 0.5f
* hud
->fb_height
;
474 viewport
.scale
[2] = 1.0f
;
475 viewport
.translate
[0] = 0.5f
* hud
->fb_width
;
476 viewport
.translate
[1] = 0.5f
* hud
->fb_height
;
477 viewport
.translate
[2] = 0.0f
;
479 cso_set_framebuffer(cso
, &fb
);
480 cso_set_sample_mask(cso
, ~0);
481 cso_set_min_samples(cso
, 1);
482 cso_set_blend(cso
, &hud
->alpha_blend
);
483 cso_set_depth_stencil_alpha(cso
, &hud
->dsa
);
484 cso_set_rasterizer(cso
, &hud
->rasterizer
);
485 cso_set_viewport(cso
, &viewport
);
486 cso_set_stream_outputs(cso
, 0, NULL
, NULL
);
487 cso_set_tessctrl_shader_handle(cso
, NULL
);
488 cso_set_tesseval_shader_handle(cso
, NULL
);
489 cso_set_geometry_shader_handle(cso
, NULL
);
490 cso_set_vertex_shader_handle(cso
, hud
->vs
);
491 cso_set_vertex_elements(cso
, 2, hud
->velems
);
492 cso_set_render_condition(cso
, NULL
, FALSE
, 0);
493 cso_set_sampler_views(cso
, PIPE_SHADER_FRAGMENT
, 1,
494 &hud
->font_sampler_view
);
495 cso_set_samplers(cso
, PIPE_SHADER_FRAGMENT
, 1, sampler_states
);
496 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
498 /* prepare vertex buffers */
499 hud_alloc_vertices(hud
, &hud
->bg
, 4 * 128, 2 * sizeof(float));
500 hud_alloc_vertices(hud
, &hud
->whitelines
, 4 * 256, 2 * sizeof(float));
501 hud_alloc_vertices(hud
, &hud
->text
, 4 * 512, 4 * sizeof(float));
503 /* prepare all graphs */
504 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
505 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
506 gr
->query_new_value(gr
);
509 hud_pane_accumulate_vertices(hud
, pane
);
512 /* unmap the uploader's vertex buffer before drawing */
513 u_upload_unmap(hud
->uploader
);
515 /* draw accumulated vertices for background quads */
516 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
518 if (hud
->bg
.num_vertices
) {
519 hud
->constants
.color
[0] = 0;
520 hud
->constants
.color
[1] = 0;
521 hud
->constants
.color
[2] = 0;
522 hud
->constants
.color
[3] = 0.666f
;
523 hud
->constants
.translate
[0] = 0;
524 hud
->constants
.translate
[1] = 0;
525 hud
->constants
.scale
[0] = 1;
526 hud
->constants
.scale
[1] = 1;
528 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
529 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
531 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->bg
.num_vertices
);
533 pipe_resource_reference(&hud
->bg
.vbuf
.buffer
, NULL
);
535 /* draw accumulated vertices for white lines */
536 hud
->constants
.color
[0] = 1;
537 hud
->constants
.color
[1] = 1;
538 hud
->constants
.color
[2] = 1;
539 hud
->constants
.color
[3] = 1;
540 hud
->constants
.translate
[0] = 0;
541 hud
->constants
.translate
[1] = 0;
542 hud
->constants
.scale
[0] = 1;
543 hud
->constants
.scale
[1] = 1;
544 cso_set_constant_buffer(cso
, PIPE_SHADER_VERTEX
, 0, &hud
->constbuf
);
546 if (hud
->whitelines
.num_vertices
) {
547 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
548 &hud
->whitelines
.vbuf
);
549 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_color
);
550 cso_draw_arrays(cso
, PIPE_PRIM_LINES
, 0, hud
->whitelines
.num_vertices
);
552 pipe_resource_reference(&hud
->whitelines
.vbuf
.buffer
, NULL
);
554 /* draw accumulated vertices for text */
555 if (hud
->text
.num_vertices
) {
556 cso_set_vertex_buffers(cso
, cso_get_aux_vertex_buffer_slot(cso
), 1,
558 cso_set_fragment_shader_handle(hud
->cso
, hud
->fs_text
);
559 cso_draw_arrays(cso
, PIPE_PRIM_QUADS
, 0, hud
->text
.num_vertices
);
561 pipe_resource_reference(&hud
->text
.vbuf
.buffer
, NULL
);
564 LIST_FOR_EACH_ENTRY(pane
, &hud
->pane_list
, head
) {
566 hud_pane_draw_colored_objects(hud
, pane
);
570 cso_restore_framebuffer(cso
);
571 cso_restore_sample_mask(cso
);
572 cso_restore_min_samples(cso
);
573 cso_restore_blend(cso
);
574 cso_restore_depth_stencil_alpha(cso
);
575 cso_restore_fragment_shader(cso
);
576 cso_restore_fragment_sampler_views(cso
);
577 cso_restore_fragment_samplers(cso
);
578 cso_restore_rasterizer(cso
);
579 cso_restore_viewport(cso
);
580 cso_restore_stream_outputs(cso
);
581 cso_restore_tessctrl_shader(cso
);
582 cso_restore_tesseval_shader(cso
);
583 cso_restore_geometry_shader(cso
);
584 cso_restore_vertex_shader(cso
);
585 cso_restore_vertex_elements(cso
);
586 cso_restore_aux_vertex_buffer_slot(cso
);
587 cso_restore_constant_buffer_slot0(cso
, PIPE_SHADER_VERTEX
);
588 cso_restore_render_condition(cso
);
590 pipe_surface_reference(&surf
, NULL
);
594 * Set the maximum value for the Y axis of the graph.
595 * This scales the graph accordingly.
598 hud_pane_set_max_value(struct hud_pane
*pane
, uint64_t value
)
600 pane
->max_value
= value
;
601 pane
->yscale
= -(int)pane
->inner_height
/ (float)pane
->max_value
;
605 hud_pane_update_dyn_ceiling(struct hud_graph
*gr
, struct hud_pane
*pane
)
610 if (pane
->dyn_ceil_last_ran
!= gr
->index
) {
611 LIST_FOR_EACH_ENTRY(gr
, &pane
->graph_list
, head
) {
612 for (i
= 0; i
< gr
->num_vertices
; ++i
) {
613 tmp
= gr
->vertices
[i
* 2 + 1] > tmp
?
614 gr
->vertices
[i
* 2 + 1] : tmp
;
618 /* Avoid setting it lower than the initial starting height. */
619 tmp
= tmp
> pane
->initial_max_value
? tmp
: pane
->initial_max_value
;
620 hud_pane_set_max_value(pane
, tmp
);
624 * Mark this adjustment run so we could avoid repeating a full update
625 * again needlessly in case the pane has more than one graph.
627 pane
->dyn_ceil_last_ran
= gr
->index
;
630 static struct hud_pane
*
631 hud_pane_create(unsigned x1
, unsigned y1
, unsigned x2
, unsigned y2
,
632 unsigned period
, uint64_t max_value
, uint64_t ceiling
,
635 struct hud_pane
*pane
= CALLOC_STRUCT(hud_pane
);
644 pane
->inner_x1
= x1
+ 1;
645 pane
->inner_x2
= x2
- 1;
646 pane
->inner_y1
= y1
+ 1;
647 pane
->inner_y2
= y2
- 1;
648 pane
->inner_width
= pane
->inner_x2
- pane
->inner_x1
;
649 pane
->inner_height
= pane
->inner_y2
- pane
->inner_y1
;
650 pane
->period
= period
;
651 pane
->max_num_vertices
= (x2
- x1
+ 2) / 2;
652 pane
->ceiling
= ceiling
;
653 pane
->dyn_ceiling
= dyn_ceiling
;
654 pane
->dyn_ceil_last_ran
= 0;
655 pane
->initial_max_value
= max_value
;
656 hud_pane_set_max_value(pane
, max_value
);
657 LIST_INITHEAD(&pane
->graph_list
);
662 * Add a graph to an existing pane.
663 * One pane can contain multiple graphs over each other.
666 hud_pane_add_graph(struct hud_pane
*pane
, struct hud_graph
*gr
)
668 static const float colors
[][3] = {
677 char *name
= gr
->name
;
679 /* replace '-' with a space */
686 assert(pane
->num_graphs
< Elements(colors
));
687 gr
->vertices
= MALLOC(pane
->max_num_vertices
* sizeof(float) * 2);
688 gr
->color
[0] = colors
[pane
->num_graphs
][0];
689 gr
->color
[1] = colors
[pane
->num_graphs
][1];
690 gr
->color
[2] = colors
[pane
->num_graphs
][2];
692 LIST_ADDTAIL(&gr
->head
, &pane
->graph_list
);
697 hud_graph_add_value(struct hud_graph
*gr
, uint64_t value
)
699 gr
->current_value
= value
;
700 value
= value
> gr
->pane
->ceiling
? gr
->pane
->ceiling
: value
;
702 if (gr
->index
== gr
->pane
->max_num_vertices
) {
704 gr
->vertices
[1] = gr
->vertices
[(gr
->index
-1)*2+1];
707 gr
->vertices
[(gr
->index
)*2+0] = (float) (gr
->index
* 2);
708 gr
->vertices
[(gr
->index
)*2+1] = (float) value
;
711 if (gr
->num_vertices
< gr
->pane
->max_num_vertices
) {
715 if (gr
->pane
->dyn_ceiling
== true) {
716 hud_pane_update_dyn_ceiling(gr
, gr
->pane
);
718 if (value
> gr
->pane
->max_value
) {
719 hud_pane_set_max_value(gr
->pane
, value
);
724 hud_graph_destroy(struct hud_graph
*graph
)
726 FREE(graph
->vertices
);
727 if (graph
->free_query_data
)
728 graph
->free_query_data(graph
->query_data
);
733 * Read a string from the environment variable.
734 * The separators "+", ",", ":", and ";" terminate the string.
735 * Return the number of read characters.
738 parse_string(const char *s
, char *out
)
742 for (i
= 0; *s
&& *s
!= '+' && *s
!= ',' && *s
!= ':' && *s
!= ';';
749 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) while "
750 "parsing a string\n", *s
, *s
);
755 read_pane_settings(char *str
, unsigned * const x
, unsigned * const y
,
756 unsigned * const width
, unsigned * const height
,
757 uint64_t * const ceiling
, boolean
* const dyn_ceiling
)
762 while (*str
== '.') {
767 *x
= strtoul(str
, &ret
, 10);
773 *y
= strtoul(str
, &ret
, 10);
779 tmp
= strtoul(str
, &ret
, 10);
780 *width
= tmp
> 80 ? tmp
: 80; /* 80 is chosen arbitrarily */
785 * Prevent setting height to less than 50. If the height is set to less,
786 * the text of the Y axis labels on the graph will start overlapping.
790 tmp
= strtoul(str
, &ret
, 10);
791 *height
= tmp
> 50 ? tmp
: 50;
797 tmp
= strtoul(str
, &ret
, 10);
798 *ceiling
= tmp
> 10 ? tmp
: 10;
809 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c'\n", *str
);
818 has_occlusion_query(struct pipe_screen
*screen
)
820 return screen
->get_param(screen
, PIPE_CAP_OCCLUSION_QUERY
) != 0;
824 has_streamout(struct pipe_screen
*screen
)
826 return screen
->get_param(screen
, PIPE_CAP_MAX_STREAM_OUTPUT_BUFFERS
) != 0;
830 has_pipeline_stats_query(struct pipe_screen
*screen
)
832 return screen
->get_param(screen
, PIPE_CAP_QUERY_PIPELINE_STATISTICS
) != 0;
836 hud_parse_env_var(struct hud_context
*hud
, const char *env
)
839 char name_a
[256], s
[256];
841 struct hud_pane
*pane
= NULL
;
842 unsigned x
= 10, y
= 10;
843 unsigned width
= 251, height
= 100;
844 unsigned period
= 500 * 1000; /* default period (1/2 second) */
845 uint64_t ceiling
= UINT64_MAX
;
846 unsigned column_width
= 251;
847 boolean dyn_ceiling
= false;
848 const char *period_env
;
851 * The GALLIUM_HUD_PERIOD env var sets the graph update rate.
852 * The env var is in seconds (a float).
853 * Zero means update after every frame.
855 period_env
= getenv("GALLIUM_HUD_PERIOD");
857 float p
= (float) atof(period_env
);
859 period
= (unsigned) (p
* 1000 * 1000);
863 while ((num
= parse_string(env
, name_a
)) != 0) {
866 /* check for explicit location, size and etc. settings */
867 name
= read_pane_settings(name_a
, &x
, &y
, &width
, &height
, &ceiling
,
871 * Keep track of overall column width to avoid pane overlapping in case
872 * later we create a new column while the bottom pane in the current
873 * column is less wide than the rest of the panes in it.
875 column_width
= width
> column_width
? width
: column_width
;
878 pane
= hud_pane_create(x
, y
, x
+ width
, y
+ height
, period
, 10,
879 ceiling
, dyn_ceiling
);
885 /* IF YOU CHANGE THIS, UPDATE print_help! */
886 if (strcmp(name
, "fps") == 0) {
887 hud_fps_graph_install(pane
);
889 else if (strcmp(name
, "cpu") == 0) {
890 hud_cpu_graph_install(pane
, ALL_CPUS
);
892 else if (sscanf(name
, "cpu%u%s", &i
, s
) == 1) {
893 hud_cpu_graph_install(pane
, i
);
895 else if (strcmp(name
, "samples-passed") == 0 &&
896 has_occlusion_query(hud
->pipe
->screen
)) {
897 hud_pipe_query_install(pane
, hud
->pipe
, "samples-passed",
898 PIPE_QUERY_OCCLUSION_COUNTER
, 0, 0,
899 PIPE_DRIVER_QUERY_TYPE_UINT64
,
900 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
);
902 else if (strcmp(name
, "primitives-generated") == 0 &&
903 has_streamout(hud
->pipe
->screen
)) {
904 hud_pipe_query_install(pane
, hud
->pipe
, "primitives-generated",
905 PIPE_QUERY_PRIMITIVES_GENERATED
, 0, 0,
906 PIPE_DRIVER_QUERY_TYPE_UINT64
,
907 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
);
910 boolean processed
= FALSE
;
912 /* pipeline statistics queries */
913 if (has_pipeline_stats_query(hud
->pipe
->screen
)) {
914 static const char *pipeline_statistics_names
[] =
921 "clipper-invocations",
922 "clipper-primitives-generated",
928 for (i
= 0; i
< Elements(pipeline_statistics_names
); ++i
)
929 if (strcmp(name
, pipeline_statistics_names
[i
]) == 0)
931 if (i
< Elements(pipeline_statistics_names
)) {
932 hud_pipe_query_install(pane
, hud
->pipe
, name
,
933 PIPE_QUERY_PIPELINE_STATISTICS
, i
,
934 0, PIPE_DRIVER_QUERY_TYPE_UINT64
,
935 PIPE_DRIVER_QUERY_RESULT_TYPE_AVERAGE
);
942 if (!hud_driver_query_install(pane
, hud
->pipe
, name
)){
943 fprintf(stderr
, "gallium_hud: unknown driver query '%s'\n", name
);
952 fprintf(stderr
, "gallium_hud: syntax error: unexpected ':', "
953 "expected a name\n");
957 num
= parse_string(env
, s
);
960 if (num
&& sscanf(s
, "%u", &i
) == 1) {
961 hud_pane_set_max_value(pane
, i
);
962 pane
->initial_max_value
= i
;
965 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c' (%i) "
966 "after ':'\n", *env
, *env
);
973 /* parse a separator */
981 y
+= height
+ hud
->font
.glyph_height
* (pane
->num_graphs
+ 2);
984 if (pane
&& pane
->num_graphs
) {
985 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
993 x
+= column_width
+ hud
->font
.glyph_width
* 7;
996 if (pane
&& pane
->num_graphs
) {
997 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
1001 /* Starting a new column; reset column width. */
1006 fprintf(stderr
, "gallium_hud: syntax error: unexpected '%c'\n", *env
);
1009 /* Reset to defaults for the next pane in case these were modified. */
1011 ceiling
= UINT64_MAX
;
1012 dyn_ceiling
= false;
1017 if (pane
->num_graphs
) {
1018 LIST_ADDTAIL(&pane
->head
, &hud
->pane_list
);
1027 print_help(struct pipe_screen
*screen
)
1029 int i
, num_queries
, num_cpus
= hud_get_num_cpus();
1031 puts("Syntax: GALLIUM_HUD=name1[+name2][...][:value1][,nameI...][;nameJ...]");
1033 puts(" Names are identifiers of data sources which will be drawn as graphs");
1034 puts(" in panes. Multiple graphs can be drawn in the same pane.");
1035 puts(" There can be multiple panes placed in rows and columns.");
1037 puts(" '+' separates names which will share a pane.");
1038 puts(" ':[value]' specifies the initial maximum value of the Y axis");
1039 puts(" for the given pane.");
1040 puts(" ',' creates a new pane below the last one.");
1041 puts(" ';' creates a new pane at the top of the next column.");
1043 puts(" Example: GALLIUM_HUD=\"cpu,fps;primitives-generated\"");
1045 puts(" Additionally, by prepending '.[identifier][value]' modifiers to");
1046 puts(" a name, it is possible to explicitly set the location and size");
1047 puts(" of a pane, along with limiting overall maximum value of the");
1048 puts(" Y axis and activating dynamic readjustment of the Y axis.");
1049 puts(" Several modifiers may be applied to the same pane simultaneously.");
1051 puts(" 'x[value]' sets the location of the pane on the x axis relative");
1052 puts(" to the upper-left corner of the viewport, in pixels.");
1053 puts(" 'y[value]' sets the location of the pane on the y axis relative");
1054 puts(" to the upper-left corner of the viewport, in pixels.");
1055 puts(" 'w[value]' sets width of the graph pixels.");
1056 puts(" 'h[value]' sets height of the graph in pixels.");
1057 puts(" 'c[value]' sets the ceiling of the value of the Y axis.");
1058 puts(" If the graph needs to draw values higher than");
1059 puts(" the ceiling allows, the value is clamped.");
1060 puts(" 'd' activates dynamic Y axis readjustment to set the value of");
1061 puts(" the Y axis to match the highest value still visible in the graph.");
1063 puts(" If 'c' and 'd' modifiers are used simultaneously, both are in effect:");
1064 puts(" the Y axis does not go above the restriction imposed by 'c' while");
1065 puts(" still adjusting the value of the Y axis down when appropriate.");
1067 puts(" Example: GALLIUM_HUD=\".w256.h64.x1600.y520.d.c1000fps+cpu,.datom-count\"");
1069 puts(" Available names:");
1073 for (i
= 0; i
< num_cpus
; i
++)
1074 printf(" cpu%i\n", i
);
1076 if (has_occlusion_query(screen
))
1077 puts(" samples-passed");
1078 if (has_streamout(screen
))
1079 puts(" primitives-generated");
1081 if (has_pipeline_stats_query(screen
)) {
1082 puts(" ia-vertices");
1083 puts(" ia-primitives");
1084 puts(" vs-invocations");
1085 puts(" gs-invocations");
1086 puts(" gs-primitives");
1087 puts(" clipper-invocations");
1088 puts(" clipper-primitives-generated");
1089 puts(" ps-invocations");
1090 puts(" hs-invocations");
1091 puts(" ds-invocations");
1092 puts(" cs-invocations");
1095 if (screen
->get_driver_query_info
){
1096 struct pipe_driver_query_info info
;
1097 num_queries
= screen
->get_driver_query_info(screen
, 0, NULL
);
1099 for (i
= 0; i
< num_queries
; i
++){
1100 screen
->get_driver_query_info(screen
, i
, &info
);
1101 printf(" %s\n", info
.name
);
1109 struct hud_context
*
1110 hud_create(struct pipe_context
*pipe
, struct cso_context
*cso
)
1112 struct hud_context
*hud
;
1113 struct pipe_sampler_view view_templ
;
1115 const char *env
= debug_get_option("GALLIUM_HUD", NULL
);
1120 if (strcmp(env
, "help") == 0) {
1121 print_help(pipe
->screen
);
1125 hud
= CALLOC_STRUCT(hud_context
);
1131 hud
->uploader
= u_upload_create(pipe
, 256 * 1024, 16,
1132 PIPE_BIND_VERTEX_BUFFER
);
1135 if (!util_font_create(pipe
, UTIL_FONT_FIXED_8X13
, &hud
->font
)) {
1136 u_upload_destroy(hud
->uploader
);
1142 hud
->alpha_blend
.rt
[0].colormask
= PIPE_MASK_RGBA
;
1143 hud
->alpha_blend
.rt
[0].blend_enable
= 1;
1144 hud
->alpha_blend
.rt
[0].rgb_func
= PIPE_BLEND_ADD
;
1145 hud
->alpha_blend
.rt
[0].rgb_src_factor
= PIPE_BLENDFACTOR_SRC_ALPHA
;
1146 hud
->alpha_blend
.rt
[0].rgb_dst_factor
= PIPE_BLENDFACTOR_INV_SRC_ALPHA
;
1147 hud
->alpha_blend
.rt
[0].alpha_func
= PIPE_BLEND_ADD
;
1148 hud
->alpha_blend
.rt
[0].alpha_src_factor
= PIPE_BLENDFACTOR_ZERO
;
1149 hud
->alpha_blend
.rt
[0].alpha_dst_factor
= PIPE_BLENDFACTOR_ONE
;
1151 /* fragment shader */
1153 util_make_fragment_passthrough_shader(pipe
,
1154 TGSI_SEMANTIC_COLOR
,
1155 TGSI_INTERPOLATE_CONSTANT
,
1159 /* Read a texture and do .xxxx swizzling. */
1160 static const char *fragment_shader_text
= {
1162 "DCL IN[0], GENERIC[0], LINEAR\n"
1164 "DCL OUT[0], COLOR[0]\n"
1167 "TEX TEMP[0], IN[0], SAMP[0], RECT\n"
1168 "MOV OUT[0], TEMP[0].xxxx\n"
1172 struct tgsi_token tokens
[1000];
1173 struct pipe_shader_state state
= {tokens
};
1175 if (!tgsi_text_translate(fragment_shader_text
, tokens
, Elements(tokens
))) {
1177 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1178 u_upload_destroy(hud
->uploader
);
1183 hud
->fs_text
= pipe
->create_fs_state(pipe
, &state
);
1187 hud
->rasterizer
.half_pixel_center
= 1;
1188 hud
->rasterizer
.bottom_edge_rule
= 1;
1189 hud
->rasterizer
.depth_clip
= 1;
1190 hud
->rasterizer
.line_width
= 1;
1191 hud
->rasterizer
.line_last_pixel
= 1;
1195 static const char *vertex_shader_text
= {
1198 "DCL OUT[0], POSITION\n"
1199 "DCL OUT[1], COLOR[0]\n" /* color */
1200 "DCL OUT[2], GENERIC[0]\n" /* texcoord */
1202 * [1] = (2/fb_width, 2/fb_height, xoffset, yoffset)
1203 * [2] = (xscale, yscale, 0, 0) */
1206 "IMM[0] FLT32 { -1, 0, 0, 1 }\n"
1208 /* v = in * (xscale, yscale) + (xoffset, yoffset) */
1209 "MAD TEMP[0].xy, IN[0], CONST[2].xyyy, CONST[1].zwww\n"
1210 /* pos = v * (2 / fb_width, 2 / fb_height) - (1, 1) */
1211 "MAD OUT[0].xy, TEMP[0], CONST[1].xyyy, IMM[0].xxxx\n"
1212 "MOV OUT[0].zw, IMM[0]\n"
1214 "MOV OUT[1], CONST[0]\n"
1215 "MOV OUT[2], IN[1]\n"
1219 struct tgsi_token tokens
[1000];
1220 struct pipe_shader_state state
= {tokens
};
1222 if (!tgsi_text_translate(vertex_shader_text
, tokens
, Elements(tokens
))) {
1224 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1225 u_upload_destroy(hud
->uploader
);
1230 hud
->vs
= pipe
->create_vs_state(pipe
, &state
);
1233 /* vertex elements */
1234 for (i
= 0; i
< 2; i
++) {
1235 hud
->velems
[i
].src_offset
= i
* 2 * sizeof(float);
1236 hud
->velems
[i
].src_format
= PIPE_FORMAT_R32G32_FLOAT
;
1237 hud
->velems
[i
].vertex_buffer_index
= cso_get_aux_vertex_buffer_slot(cso
);
1241 u_sampler_view_default_template(
1242 &view_templ
, hud
->font
.texture
, hud
->font
.texture
->format
);
1243 hud
->font_sampler_view
= pipe
->create_sampler_view(pipe
, hud
->font
.texture
,
1246 /* sampler state (for font drawing) */
1247 hud
->font_sampler_state
.wrap_s
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1248 hud
->font_sampler_state
.wrap_t
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1249 hud
->font_sampler_state
.wrap_r
= PIPE_TEX_WRAP_CLAMP_TO_EDGE
;
1250 hud
->font_sampler_state
.normalized_coords
= 0;
1253 hud
->constbuf
.buffer_size
= sizeof(hud
->constants
);
1254 hud
->constbuf
.user_buffer
= &hud
->constants
;
1256 LIST_INITHEAD(&hud
->pane_list
);
1258 hud_parse_env_var(hud
, env
);
1263 hud_destroy(struct hud_context
*hud
)
1265 struct pipe_context
*pipe
= hud
->pipe
;
1266 struct hud_pane
*pane
, *pane_tmp
;
1267 struct hud_graph
*graph
, *graph_tmp
;
1269 LIST_FOR_EACH_ENTRY_SAFE(pane
, pane_tmp
, &hud
->pane_list
, head
) {
1270 LIST_FOR_EACH_ENTRY_SAFE(graph
, graph_tmp
, &pane
->graph_list
, head
) {
1271 LIST_DEL(&graph
->head
);
1272 hud_graph_destroy(graph
);
1274 LIST_DEL(&pane
->head
);
1278 pipe
->delete_fs_state(pipe
, hud
->fs_color
);
1279 pipe
->delete_fs_state(pipe
, hud
->fs_text
);
1280 pipe
->delete_vs_state(pipe
, hud
->vs
);
1281 pipe_sampler_view_reference(&hud
->font_sampler_view
, NULL
);
1282 pipe_resource_reference(&hud
->font
.texture
, NULL
);
1283 u_upload_destroy(hud
->uploader
);