src/gallium/auxiliary/hud/hud_driver_query.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2013 Marek Olšák <maraeo@gmail.com>
   4  * All Rights Reserved.
   5  *
   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:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  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.
  25  *
  26  **************************************************************************/
  27
  28 /* This file contains code for reading values from pipe queries
  29  * for displaying on the HUD. To prevent stalls when reading queries, we
  30  * keep a list of busy queries in a ring. We read only those queries which
  31  * are idle.
  32  */
  33
  34 #include "hud/hud_private.h"
  35 #include "pipe/p_screen.h"
  36 #include "os/os_time.h"
  37 #include "util/u_memory.h"
  38 #include <stdio.h>
  39
  40 #define NUM_QUERIES 8
  41
  42 struct query_info {
  43    struct pipe_context *pipe;
  44    unsigned query_type;
  45    unsigned result_index; /* unit depends on query_type */
  46
  47    /* Ring of queries. If a query is busy, we use another slot. */
  48    struct pipe_query *query[NUM_QUERIES];
  49    unsigned head, tail;
  50    unsigned num_queries;
  51
  52    uint64_t last_time;
  53    uint64_t results_cumulative;
  54    unsigned num_results;
  55 };
  56
  57 static void
  58 query_new_value(struct hud_graph *gr)
  59 {
  60    struct query_info *info = gr->query_data;
  61    struct pipe_context *pipe = info->pipe;
  62    uint64_t now = os_time_get();
  63
  64    if (info->last_time) {
  65       if (info->query[info->head])
  66          pipe->end_query(pipe, info->query[info->head]);
  67
  68       /* read query results */
  69       while (1) {
  70          struct pipe_query *query = info->query[info->tail];
  71          union pipe_query_result result;
  72          uint64_t *res64 = (uint64_t *)&result;
  73
  74          if (query && pipe->get_query_result(pipe, query, FALSE, &result)) {
  75             info->results_cumulative += res64[info->result_index];
  76             info->num_results++;
  77
  78             if (info->tail == info->head)
  79                break;
  80
  81             info->tail = (info->tail+1) % NUM_QUERIES;
  82          }
  83          else {
  84             /* the oldest query is busy */
  85             if ((info->head+1) % NUM_QUERIES == info->tail) {
  86                /* all queries are busy, throw away the last query and create
  87                 * a new one */
  88                fprintf(stderr,
  89                        "gallium_hud: all queries are busy after %i frames, "
  90                        "can't add another query\n",
  91                        NUM_QUERIES);
  92                if (info->query[info->head])
  93                   pipe->destroy_query(pipe, info->query[info->head]);
  94                info->query[info->head] =
  95                      pipe->create_query(pipe, info->query_type, 0);
  96             }
  97             else {
  98                /* the last query is busy, we need to add a new one we can use
  99                 * for this frame */
 100                info->head = (info->head+1) % NUM_QUERIES;
 101                if (!info->query[info->head]) {
 102                   info->query[info->head] =
 103                         pipe->create_query(pipe, info->query_type, 0);
 104                }
 105             }
 106             break;
 107          }
 108       }
 109
 110       if (info->num_results && info->last_time + gr->pane->period <= now) {
 111          /* compute the average value across all frames */
 112          hud_graph_add_value(gr, info->results_cumulative / info->num_results);
 113
 114          info->last_time = now;
 115          info->results_cumulative = 0;
 116          info->num_results = 0;
 117       }
 118    }
 119    else {
 120       /* initialize */
 121       info->last_time = now;
 122       info->query[info->head] = pipe->create_query(pipe, info->query_type, 0);
 123    }
 124
 125    if (info->query[info->head])
 126       pipe->begin_query(pipe, info->query[info->head]);
 127 }
 128
 129 static void
 130 free_query_info(void *ptr)
 131 {
 132    struct query_info *info = ptr;
 133
 134    if (info->last_time) {
 135       struct pipe_context *pipe = info->pipe;
 136       int i;
 137
 138       pipe->end_query(pipe, info->query[info->head]);
 139
 140       for (i = 0; i < Elements(info->query); i++) {
 141          if (info->query[i]) {
 142             pipe->destroy_query(pipe, info->query[i]);
 143          }
 144       }
 145    }
 146    FREE(info);
 147 }
 148
 149 void
 150 hud_pipe_query_install(struct hud_pane *pane, struct pipe_context *pipe,
 151                        const char *name, unsigned query_type,
 152                        unsigned result_index,
 153                        uint64_t max_value, boolean uses_byte_units)
 154 {
 155    struct hud_graph *gr;
 156    struct query_info *info;
 157
 158    gr = CALLOC_STRUCT(hud_graph);
 159    if (!gr)
 160       return;
 161
 162    strncpy(gr->name, name, sizeof(gr->name));
 163    gr->name[sizeof(gr->name) - 1] = '\0';
 164    gr->query_data = CALLOC_STRUCT(query_info);
 165    if (!gr->query_data) {
 166       FREE(gr);
 167       return;
 168    }
 169
 170    gr->query_new_value = query_new_value;
 171    gr->free_query_data = free_query_info;
 172
 173    info = gr->query_data;
 174    info->pipe = pipe;
 175    info->query_type = query_type;
 176    info->result_index = result_index;
 177
 178    hud_pane_add_graph(pane, gr);
 179    if (pane->max_value < max_value)
 180       hud_pane_set_max_value(pane, max_value);
 181    if (uses_byte_units)
 182       pane->uses_byte_units = TRUE;
 183 }
 184
 185 boolean
 186 hud_driver_query_install(struct hud_pane *pane, struct pipe_context *pipe,
 187                          const char *name)
 188 {
 189    struct pipe_screen *screen = pipe->screen;
 190    struct pipe_driver_query_info query;
 191    unsigned num_queries, i;
 192    boolean uses_byte_units;
 193    boolean found = FALSE;
 194
 195    if (!screen->get_driver_query_info)
 196       return FALSE;
 197
 198    num_queries = screen->get_driver_query_info(screen, 0, NULL);
 199
 200    for (i = 0; i < num_queries; i++) {
 201       if (screen->get_driver_query_info(screen, i, &query) &&
 202           strcmp(query.name, name) == 0) {
 203          found = TRUE;
 204          break;
 205       }
 206    }
 207
 208    if (!found)
 209       return FALSE;
 210
 211    uses_byte_units = query.type == PIPE_DRIVER_QUERY_TYPE_BYTES;
 212    hud_pipe_query_install(pane, pipe, query.name, query.query_type, 0,
 213                           query.max_value.u64, uses_byte_units);
 214
 215    return TRUE;
 216 }