git.cworth.org Git - fips/blob - metrics.h

   1 /* Copyright © 2013, Intel Corporation
   2  *
   3  * Permission is hereby granted, free of charge, to any person obtaining a copy
   4  * of this software and associated documentation files (the "Software"), to deal
   5  * in the Software without restriction, including without limitation the rights
   6  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   7  * copies of the Software, and to permit persons to whom the Software is
   8  * furnished to do so, subject to the following conditions:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  18  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  19  * THE SOFTWARE.
  20  */
  21
  22 #ifndef METRICS_H
  23 #define METRICS_H
  24
  25 typedef enum
  26 {
  27         METRICS_OP_ACCUM,
  28         METRICS_OP_BUFFER_DATA,
  29         METRICS_OP_BUFFER_SUB_DATA,
  30         METRICS_OP_BITMAP,
  31         METRICS_OP_BLIT_FRAMEBUFFER,
  32         METRICS_OP_CLEAR,
  33         METRICS_OP_CLEAR_BUFFER_DATA,
  34         METRICS_OP_CLEAR_TEX_IMAGE,
  35         METRICS_OP_COPY_PIXELS,
  36         METRICS_OP_COPY_TEX_IMAGE,
  37         METRICS_OP_DRAW_PIXELS,
  38         METRICS_OP_GET_TEX_IMAGE,
  39         METRICS_OP_READ_PIXELS,
  40         METRICS_OP_TEX_IMAGE,
  41
  42         /* METRICS_OP_SHADER must be last.
  43          *
  44          * All larger values for metrics_op_t are interpreted as:
  45          *
  46          *      METRICS_OP_SHADER + shader_program_number
  47          *
  48          * to indicate a specific shader program.
  49          */
  50         METRICS_OP_SHADER
  51 } metrics_op_t;
  52
  53 typedef struct metrics metrics_t;
  54
  55 /* Create a new metrics_t object for tracking metrics. */
  56 metrics_t *
  57 metrics_create (void);
  58
  59 /* Free all internal resources of a metrics_t
  60  *
  61  * All outstanding metrics counters are discarded.
  62  *
  63  * The metrics_t object remains valid and may be used again.
  64  */
  65 void
  66 metrics_fini (metrics_t *metrics);
  67
  68 /* Destroy a metrics_t object.
  69  *
  70  * After this call, the metrics_t* value is and must not be used
  71  * further. */
  72 void
  73 metrics_destroy (metrics_t *metrics);
  74
  75 /* Start accumulating GPU time.
  76  *
  77  * The time accumulated will be accounted against the
  78  * current program (as set with metrics_set_current_program).
  79  */
  80 void
  81 metrics_counter_start (void);
  82
  83 /* Stop accumulating GPU time (stops the most-recently started counter) */
  84 void
  85 metrics_counter_stop (void);
  86
  87 /* Set a metrics_op_t value to indicate what kind of operation is
  88  * being performed.
  89  *
  90  * The metrics-tracking code will account for timings by accumulating
  91  * measured counter values into a separate counter for each
  92  * metrics_op_t value, (so that the report can describe which
  93  * operations are the most expensive).
  94  *
  95  * In addition, for the value METRICS_OP_SHADER, each specific shader
  96  * program can be distinguished. To accomplish this, pass a value of
  97  * METRICS_OP_SHADER + shader_program_number to this function.
  98  */
  99 void
 100 metrics_set_current_op (metrics_op_t op);
 101
 102 /* Return the current metrics_op_t value, (the value most-recently-set
 103  * with a call to metrics_set_current_op).
 104  */
 105 metrics_op_t
 106 metrics_get_current_op (void);
 107
 108 /* Should be called at the end of every function wrapper for a
 109  * function that ends a frame, (glXSwapBuffers and similar).
 110  *
 111  * This function performs whatever bookkeeping is necessary to
 112  * generate a timing report, then emits that report.
 113  */
 114 void
 115 metrics_end_frame (void);
 116
 117 /* Process outstanding metrics requests, accumulating results.
 118  *
 119  * This function is called automatically by metrics_end_frame.
 120  *
 121  * During a frame, it may be important to call this function to avoid
 122  * too many oustanding timer/performance-monitor queries. At the same
 123  * time, it's important not to call this function too frequently,
 124  * since collection of metrics information will result in flushes of
 125  * the OpenGL pipeline which can interfere with the behavior being
 126  * measured.
 127  */
 128 void
 129 metrics_collect_available (void);
 130
 131 #endif