src/intel/perf/gen_perf.h

   1 /*
   2  * Copyright © 2018 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #ifndef GEN_PERF_H
  25 #define GEN_PERF_H
  26
  27 #include <stdio.h>
  28 #include <stdint.h>
  29 #include <string.h>
  30
  31 #if defined(MAJOR_IN_SYSMACROS)
  32 #include <sys/sysmacros.h>
  33 #elif defined(MAJOR_IN_MKDEV)
  34 #include <sys/mkdev.h>
  35 #endif
  36
  37 #include "util/hash_table.h"
  38 #include "compiler/glsl/list.h"
  39 #include "util/ralloc.h"
  40
  41 struct gen_device_info;
  42
  43 struct gen_perf_config;
  44 struct gen_perf_query_info;
  45
  46 enum gen_perf_counter_type {
  47    GEN_PERF_COUNTER_TYPE_EVENT,
  48    GEN_PERF_COUNTER_TYPE_DURATION_NORM,
  49    GEN_PERF_COUNTER_TYPE_DURATION_RAW,
  50    GEN_PERF_COUNTER_TYPE_THROUGHPUT,
  51    GEN_PERF_COUNTER_TYPE_RAW,
  52    GEN_PERF_COUNTER_TYPE_TIMESTAMP,
  53 };
  54
  55 enum gen_perf_counter_data_type {
  56    GEN_PERF_COUNTER_DATA_TYPE_BOOL32,
  57    GEN_PERF_COUNTER_DATA_TYPE_UINT32,
  58    GEN_PERF_COUNTER_DATA_TYPE_UINT64,
  59    GEN_PERF_COUNTER_DATA_TYPE_FLOAT,
  60    GEN_PERF_COUNTER_DATA_TYPE_DOUBLE,
  61 };
  62
  63 struct gen_pipeline_stat {
  64    uint32_t reg;
  65    uint32_t numerator;
  66    uint32_t denominator;
  67 };
  68
  69 /*
  70  * The largest OA formats we can use include:
  71  * For Haswell:
  72  *   1 timestamp, 45 A counters, 8 B counters and 8 C counters.
  73  * For Gen8+
  74  *   1 timestamp, 1 clock, 36 A counters, 8 B counters and 8 C counters
  75  */
  76 #define MAX_OA_REPORT_COUNTERS 62
  77
  78 /*
  79  * When currently allocate only one page for pipeline statistics queries. Here
  80  * we derived the maximum number of counters for that amount.
  81  */
  82 #define STATS_BO_SIZE               4096
  83 #define STATS_BO_END_OFFSET_BYTES   (STATS_BO_SIZE / 2)
  84 #define MAX_STAT_COUNTERS           (STATS_BO_END_OFFSET_BYTES / 8)
  85
  86 #define I915_PERF_OA_SAMPLE_SIZE (8 +   /* drm_i915_perf_record_header */ \
  87                                   256)  /* OA counter report */
  88
  89 struct gen_perf_query_result {
  90    /**
  91     * Storage for the final accumulated OA counters.
  92     */
  93    uint64_t accumulator[MAX_OA_REPORT_COUNTERS];
  94
  95    /**
  96     * Hw ID used by the context on which the query was running.
  97     */
  98    uint32_t hw_id;
  99
 100    /**
 101     * Number of reports accumulated to produce the results.
 102     */
 103    uint32_t reports_accumulated;
 104
 105    /**
 106     * Frequency in the slices of the GT at the begin and end of the
 107     * query.
 108     */
 109    uint64_t slice_frequency[2];
 110
 111    /**
 112     * Frequency in the unslice of the GT at the begin and end of the
 113     * query.
 114     */
 115    uint64_t unslice_frequency[2];
 116 };
 117
 118 struct gen_perf_query_counter {
 119    const char *name;
 120    const char *desc;
 121    enum gen_perf_counter_type type;
 122    enum gen_perf_counter_data_type data_type;
 123    uint64_t raw_max;
 124    size_t offset;
 125
 126    union {
 127       uint64_t (*oa_counter_read_uint64)(struct gen_perf_config *perf,
 128                                          const struct gen_perf_query_info *query,
 129                                          const uint64_t *accumulator);
 130       float (*oa_counter_read_float)(struct gen_perf_config *perf,
 131                                      const struct gen_perf_query_info *query,
 132                                      const uint64_t *accumulator);
 133       struct gen_pipeline_stat pipeline_stat;
 134    };
 135 };
 136
 137 struct gen_perf_query_register_prog {
 138    uint32_t reg;
 139    uint32_t val;
 140 };
 141
 142 /* Register programming for a given query */
 143 struct gen_perf_registers {
 144    struct gen_perf_query_register_prog *flex_regs;
 145    uint32_t n_flex_regs;
 146
 147    struct gen_perf_query_register_prog *mux_regs;
 148    uint32_t n_mux_regs;
 149
 150    struct gen_perf_query_register_prog *b_counter_regs;
 151    uint32_t n_b_counter_regs;
 152 };
 153
 154 struct gen_perf_query_info {
 155    enum gen_perf_query_type {
 156       GEN_PERF_QUERY_TYPE_OA,
 157       GEN_PERF_QUERY_TYPE_RAW,
 158       GEN_PERF_QUERY_TYPE_PIPELINE,
 159    } kind;
 160    const char *name;
 161    const char *guid;
 162    struct gen_perf_query_counter *counters;
 163    int n_counters;
 164    int max_counters;
 165    size_t data_size;
 166
 167    /* OA specific */
 168    uint64_t oa_metrics_set_id;
 169    int oa_format;
 170
 171    /* For indexing into the accumulator[] ... */
 172    int gpu_time_offset;
 173    int gpu_clock_offset;
 174    int a_offset;
 175    int b_offset;
 176    int c_offset;
 177
 178    struct gen_perf_registers config;
 179 };
 180
 181 struct gen_perf_config {
 182    bool i915_query_supported;
 183
 184    struct gen_perf_query_info *queries;
 185    int n_queries;
 186
 187    /* Variables referenced in the XML meta data for OA performance
 188     * counters, e.g in the normalization equations.
 189     *
 190     * All uint64_t for consistent operand types in generated code
 191     */
 192    struct {
 193       uint64_t timestamp_frequency; /** $GpuTimestampFrequency */
 194       uint64_t n_eus;               /** $EuCoresTotalCount */
 195       uint64_t n_eu_slices;         /** $EuSlicesTotalCount */
 196       uint64_t n_eu_sub_slices;     /** $EuSubslicesTotalCount */
 197       uint64_t eu_threads_count;    /** $EuThreadsCount */
 198       uint64_t slice_mask;          /** $SliceMask */
 199       uint64_t subslice_mask;       /** $SubsliceMask */
 200       uint64_t gt_min_freq;         /** $GpuMinFrequency */
 201       uint64_t gt_max_freq;         /** $GpuMaxFrequency */
 202       uint64_t revision;            /** $SkuRevisionId */
 203    } sys_vars;
 204
 205    /* OA metric sets, indexed by GUID, as know by Mesa at build time, to
 206     * cross-reference with the GUIDs of configs advertised by the kernel at
 207     * runtime
 208     */
 209    struct hash_table *oa_metrics_table;
 210
 211    /* Location of the device's sysfs entry. */
 212    char sysfs_dev_dir[256];
 213
 214    struct {
 215       void *(*bo_alloc)(void *bufmgr, const char *name, uint64_t size);
 216       void (*bo_unreference)(void *bo);
 217       void *(*bo_map)(void *ctx, void *bo, unsigned flags);
 218       void (*bo_unmap)(void *bo);
 219       bool (*batch_references)(void *batch, void *bo);
 220       void (*bo_wait_rendering)(void *bo);
 221       int (*bo_busy)(void *bo);
 222       void (*emit_stall_at_pixel_scoreboard)(void *ctx);
 223       void (*emit_mi_report_perf_count)(void *ctx,
 224                                         void *bo,
 225                                         uint32_t offset_in_bytes,
 226                                         uint32_t report_id);
 227       void (*batchbuffer_flush)(void *ctx,
 228                                 const char *file, int line);
 229       void (*capture_frequency_stat_register)(void *ctx, void *bo,
 230                                               uint32_t bo_offset);
 231       void (*store_register_mem64)(void *ctx, void *bo, uint32_t reg, uint32_t offset);
 232
 233    } vtbl;
 234 };
 235
 236 struct gen_perf_query_object;
 237 const struct gen_perf_query_info* gen_perf_query_info(const struct gen_perf_query_object *);
 238
 239 void gen_perf_init_metrics(struct gen_perf_config *perf_cfg,
 240                            const struct gen_device_info *devinfo,
 241                            int drm_fd);
 242
 243 /** Query i915 for a metric id using guid.
 244  */
 245 bool gen_perf_load_metric_id(struct gen_perf_config *perf_cfg,
 246                              const char *guid,
 247                              uint64_t *metric_id);
 248
 249 /** Load a configuation's content from i915 using a guid.
 250  */
 251 struct gen_perf_registers *gen_perf_load_configuration(struct gen_perf_config *perf_cfg,
 252                                                       int fd, const char *guid);
 253
 254 /** Store a configuration into i915 using guid and return a new metric id.
 255  *
 256  * If guid is NULL, then a generated one will be provided by hashing the
 257  * content of the configuration.
 258  */
 259 uint64_t gen_perf_store_configuration(struct gen_perf_config *perf_cfg, int fd,
 260                                       const struct gen_perf_registers *config,
 261                                       const char *guid);
 262
 263 /** Read the slice/unslice frequency from 2 OA reports and store then into
 264  *  result.
 265  */
 266 void gen_perf_query_result_read_frequencies(struct gen_perf_query_result *result,
 267                                             const struct gen_device_info *devinfo,
 268                                             const uint32_t *start,
 269                                             const uint32_t *end);
 270 /** Accumulate the delta between 2 OA reports into result for a given query.
 271  */
 272 void gen_perf_query_result_accumulate(struct gen_perf_query_result *result,
 273                                       const struct gen_perf_query_info *query,
 274                                       const uint32_t *start,
 275                                       const uint32_t *end);
 276 void gen_perf_query_result_clear(struct gen_perf_query_result *result);
 277
 278 struct gen_perf_context;
 279 struct gen_perf_context *gen_perf_new_context(void *parent);
 280
 281 void gen_perf_init_context(struct gen_perf_context *perf_ctx,
 282                            struct gen_perf_config *perf_cfg,
 283                            void * ctx,  /* driver context (eg, brw_context) */
 284                            void * bufmgr,  /* eg brw_bufmgr */
 285                            const struct gen_device_info *devinfo,
 286                            uint32_t hw_ctx,
 287                            int drm_fd);
 288
 289 struct gen_perf_config *gen_perf_config(struct gen_perf_context *ctx);
 290
 291 int gen_perf_active_queries(struct gen_perf_context *perf_ctx,
 292                             const struct gen_perf_query_info *query);
 293
 294 static inline size_t
 295 gen_perf_query_counter_get_size(const struct gen_perf_query_counter *counter)
 296 {
 297    switch (counter->data_type) {
 298    case GEN_PERF_COUNTER_DATA_TYPE_BOOL32:
 299       return sizeof(uint32_t);
 300    case GEN_PERF_COUNTER_DATA_TYPE_UINT32:
 301       return sizeof(uint32_t);
 302    case GEN_PERF_COUNTER_DATA_TYPE_UINT64:
 303       return sizeof(uint64_t);
 304    case GEN_PERF_COUNTER_DATA_TYPE_FLOAT:
 305       return sizeof(float);
 306    case GEN_PERF_COUNTER_DATA_TYPE_DOUBLE:
 307       return sizeof(double);
 308    default:
 309       unreachable("invalid counter data type");
 310    }
 311 }
 312
 313 static inline struct gen_perf_config *
 314 gen_perf_new(void *ctx)
 315 {
 316    struct gen_perf_config *perf = rzalloc(ctx, struct gen_perf_config);
 317    return perf;
 318 }
 319
 320 struct gen_perf_query_object *
 321 gen_perf_new_query(struct gen_perf_context *, unsigned query_index);
 322
 323
 324 bool gen_perf_begin_query(struct gen_perf_context *perf_ctx,
 325                           struct gen_perf_query_object *query);
 326 void gen_perf_end_query(struct gen_perf_context *perf_ctx,
 327                         struct gen_perf_query_object *query);
 328 void gen_perf_wait_query(struct gen_perf_context *perf_ctx,
 329                          struct gen_perf_query_object *query,
 330                          void *current_batch);
 331 bool gen_perf_is_query_ready(struct gen_perf_context *perf_ctx,
 332                              struct gen_perf_query_object *query,
 333                              void *current_batch);
 334 void gen_perf_delete_query(struct gen_perf_context *perf_ctx,
 335                            struct gen_perf_query_object *query);
 336 void gen_perf_get_query_data(struct gen_perf_context *perf_ctx,
 337                              struct gen_perf_query_object *query,
 338                              int data_size,
 339                              unsigned *data,
 340                              unsigned *bytes_written);
 341
 342 void gen_perf_dump_query_count(struct gen_perf_context *perf_ctx);
 343 void gen_perf_dump_query(struct gen_perf_context *perf_ctx,
 344                          struct gen_perf_query_object *obj,
 345                          void *current_batch);
 346
 347 #endif /* GEN_PERF_H */