git.cworth.org Git - fips/blob - context.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 CONTEXT_H
  23 #define CONTEXT_H
  24
  25 #include "metrics.h"
  26 #include "metrics-info.h"
  27
  28 #include "fips-dispatch.h"
  29
  30 typedef struct context
  31 {
  32         /* Pointer to the system's context ID, (such as a GLXContext) */
  33         void *system_id;
  34
  35         metrics_info_t metrics_info;
  36         metrics_t *metrics;
  37 } context_t;
  38
  39 /* Indicate that a new context has come into use.
  40  *
  41  * Here, 'system_context_id' is a pointer to a system context (such as
  42  * a GLXContext) which fips can use to map to persistent contex_t
  43  * objects if it cares to.
  44  */
  45 void
  46 context_enter (fips_api_t api, void *system_context_id);
  47
  48 /* Indicate that the application is done using the current context for now.
  49  *
  50  * The context_enter function should be called before any subsequent
  51  * OpenGL calls are made (other than glXMakeCurrent or similar).
  52  */
  53 void
  54 context_leave (void);
  55
  56 /* Start accumulating GPU time.
  57  *
  58  * The time accumulated will be accounted against the
  59  * current operation (as set with context_set_current_op).
  60  */
  61 void
  62 context_counter_start (void);
  63
  64 /* Stop accumulating GPU time (stops the most-recently started counter) */
  65 void
  66 context_counter_stop (void);
  67
  68 /* Set a metrics_op_t value to indicate what kind of operation is
  69  * being performed.
  70  *
  71  * The metrics-tracking code will account for timings by accumulating
  72  * measured counter values into a separate counter for each
  73  * metrics_op_t value, (so that the report can describe which
  74  * operations are the most expensive).
  75  *
  76  * In addition, for the value METRICS_OP_SHADER, each specific shader
  77  * program can be distinguished. To accomplish this, pass a value of
  78  * METRICS_OP_SHADER + shader_program_number to this function.
  79  */
  80 void
  81 context_set_current_op (metrics_op_t op);
  82
  83 /* Return the current metrics_op_t value, (the value most-recently-set
  84  * with a call to context_set_current_op).
  85  */
  86 metrics_op_t
  87 context_get_current_op (void);
  88
  89 /* Should be called at the end of every function wrapper for a
  90  * function that ends a frame, (glXSwapBuffers and similar).
  91  *
  92  * This function performs whatever bookkeeping is necessary to
  93  * generate a timing report, then emits that report.
  94  */
  95 void
  96 context_end_frame (void);
  97
  98 #endif