src/intel/common/gen_decoder.h

   1 /*
   2  * Copyright © 2016 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_DECODER_H
  25 #define GEN_DECODER_H
  26
  27 #include <stdint.h>
  28 #include <stdbool.h>
  29 #include <stdio.h>
  30
  31 #include "dev/gen_device_info.h"
  32 #include "util/hash_table.h"
  33 #include "util/bitset.h"
  34
  35 #include "drm-uapi/i915_drm.h"
  36
  37 #ifdef __cplusplus
  38 extern "C" {
  39 #endif
  40
  41 struct gen_spec;
  42 struct gen_group;
  43 struct gen_field;
  44 union gen_field_value;
  45
  46 #define I915_ENGINE_CLASS_TO_MASK(x) BITSET_BIT(x)
  47
  48 static inline uint32_t gen_make_gen(uint32_t major, uint32_t minor)
  49 {
  50    return (major << 8) | minor;
  51 }
  52
  53 struct gen_group *gen_spec_find_struct(struct gen_spec *spec, const char *name);
  54 struct gen_spec *gen_spec_load(const struct gen_device_info *devinfo);
  55 struct gen_spec *gen_spec_load_from_path(const struct gen_device_info *devinfo,
  56                                          const char *path);
  57 struct gen_spec *gen_spec_load_filename(const char *filename);
  58 void gen_spec_destroy(struct gen_spec *spec);
  59 uint32_t gen_spec_get_gen(struct gen_spec *spec);
  60 struct gen_group *gen_spec_find_instruction(struct gen_spec *spec,
  61                                             enum drm_i915_gem_engine_class engine,
  62                                             const uint32_t *p);
  63 struct gen_group *gen_spec_find_register(struct gen_spec *spec, uint32_t offset);
  64 struct gen_group *gen_spec_find_register_by_name(struct gen_spec *spec, const char *name);
  65 struct gen_enum *gen_spec_find_enum(struct gen_spec *spec, const char *name);
  66
  67 int gen_group_get_length(struct gen_group *group, const uint32_t *p);
  68 const char *gen_group_get_name(struct gen_group *group);
  69 uint32_t gen_group_get_opcode(struct gen_group *group);
  70 struct gen_field *gen_group_find_field(struct gen_group *group, const char *name);
  71 struct gen_enum *gen_spec_find_enum(struct gen_spec *spec, const char *name);
  72
  73 bool gen_field_is_header(struct gen_field *field);
  74
  75 /* Only allow 5 levels of subgroup'ing
  76  */
  77 #define DECODE_MAX_ARRAY_DEPTH 5
  78
  79 struct gen_field_iterator {
  80    struct gen_group *group;
  81    char name[128];
  82    char value[128];
  83    uint64_t raw_value;
  84    struct gen_group *struct_desc;
  85    const uint32_t *p;
  86    int p_bit; /**< bit offset into p */
  87    const uint32_t *p_end;
  88    int start_bit; /**< current field starts at this bit offset into p */
  89    int end_bit; /**< current field ends at this bit offset into p */
  90
  91    int array_iter[DECODE_MAX_ARRAY_DEPTH];
  92    int level;
  93
  94    struct gen_field *field;
  95    bool print_colors;
  96 };
  97
  98 struct gen_spec {
  99    uint32_t gen;
 100
 101    struct hash_table *commands;
 102    struct hash_table *structs;
 103    struct hash_table *registers_by_name;
 104    struct hash_table *registers_by_offset;
 105    struct hash_table *enums;
 106
 107    struct hash_table *access_cache;
 108 };
 109
 110 struct gen_group {
 111    struct gen_spec *spec;
 112    char *name;
 113
 114    struct gen_field *fields; /* linked list of fields */
 115    struct gen_field *dword_length_field; /* <instruction> specific */
 116
 117    uint32_t dw_length;
 118    uint32_t engine_mask; /* <instruction> specific */
 119    uint32_t bias; /* <instruction> specific */
 120    uint32_t array_offset; /* <group> specific */
 121    uint32_t array_count; /* number of elements, <group> specific */
 122    uint32_t array_item_size; /* <group> specific */
 123    bool variable; /* <group> specific */
 124    bool fixed_length; /* True for <struct> & <register> */
 125
 126    struct gen_group *parent;
 127    struct gen_group *next;
 128
 129    uint32_t opcode_mask;
 130    uint32_t opcode;
 131
 132    uint32_t register_offset; /* <register> specific */
 133 };
 134
 135 struct gen_value {
 136    char *name;
 137    uint64_t value;
 138 };
 139
 140 struct gen_enum {
 141    char *name;
 142    int nvalues;
 143    struct gen_value **values;
 144 };
 145
 146 struct gen_type {
 147    enum {
 148       GEN_TYPE_UNKNOWN,
 149       GEN_TYPE_INT,
 150       GEN_TYPE_UINT,
 151       GEN_TYPE_BOOL,
 152       GEN_TYPE_FLOAT,
 153       GEN_TYPE_ADDRESS,
 154       GEN_TYPE_OFFSET,
 155       GEN_TYPE_STRUCT,
 156       GEN_TYPE_UFIXED,
 157       GEN_TYPE_SFIXED,
 158       GEN_TYPE_MBO,
 159       GEN_TYPE_ENUM
 160    } kind;
 161
 162    /* Struct definition for  GEN_TYPE_STRUCT */
 163    union {
 164       struct gen_group *gen_struct;
 165       struct gen_enum *gen_enum;
 166       struct {
 167          /* Integer and fractional sizes for GEN_TYPE_UFIXED and GEN_TYPE_SFIXED */
 168          int i, f;
 169       };
 170    };
 171 };
 172
 173 union gen_field_value {
 174    bool b32;
 175    float f32;
 176    uint64_t u64;
 177    int64_t i64;
 178 };
 179
 180 struct gen_field {
 181    struct gen_group *parent;
 182    struct gen_field *next;
 183    struct gen_group *array;
 184
 185    char *name;
 186    int start, end;
 187    struct gen_type type;
 188    bool has_default;
 189    uint32_t default_value;
 190
 191    struct gen_enum inline_enum;
 192 };
 193
 194 void gen_field_iterator_init(struct gen_field_iterator *iter,
 195                              struct gen_group *group,
 196                              const uint32_t *p, int p_bit,
 197                              bool print_colors);
 198
 199 bool gen_field_iterator_next(struct gen_field_iterator *iter);
 200
 201 void gen_print_group(FILE *out,
 202                      struct gen_group *group,
 203                      uint64_t offset, const uint32_t *p, int p_bit,
 204                      bool color);
 205
 206 enum gen_batch_decode_flags {
 207    /** Print in color! */
 208    GEN_BATCH_DECODE_IN_COLOR  = (1 << 0),
 209    /** Print everything, not just headers */
 210    GEN_BATCH_DECODE_FULL      = (1 << 1),
 211    /** Print offsets along with the batch */
 212    GEN_BATCH_DECODE_OFFSETS   = (1 << 2),
 213    /** Guess when a value is a float and print it as such */
 214    GEN_BATCH_DECODE_FLOATS    = (1 << 3),
 215 };
 216
 217 struct gen_batch_decode_bo {
 218    uint64_t addr;
 219    uint32_t size;
 220    const void *map;
 221 };
 222
 223 struct gen_batch_decode_ctx {
 224    /**
 225     * Return information about the buffer containing the given address.
 226     *
 227     * If the given address is inside a buffer, the map pointer should be
 228     * offset accordingly so it points at the data corresponding to address.
 229     */
 230    struct gen_batch_decode_bo (*get_bo)(void *user_data, bool ppgtt, uint64_t address);
 231    unsigned (*get_state_size)(void *user_data,
 232                               uint32_t offset_from_dynamic_state_base_addr);
 233    void *user_data;
 234
 235    FILE *fp;
 236    struct gen_spec *spec;
 237    enum gen_batch_decode_flags flags;
 238
 239    struct gen_disasm *disasm;
 240
 241    uint64_t surface_base;
 242    uint64_t dynamic_base;
 243    uint64_t instruction_base;
 244
 245    int max_vbo_decoded_lines;
 246
 247    enum drm_i915_gem_engine_class engine;
 248
 249    int n_batch_buffer_start;
 250 };
 251
 252 void gen_batch_decode_ctx_init(struct gen_batch_decode_ctx *ctx,
 253                                const struct gen_device_info *devinfo,
 254                                FILE *fp, enum gen_batch_decode_flags flags,
 255                                const char *xml_path,
 256                                struct gen_batch_decode_bo (*get_bo)(void *,
 257                                                                     bool,
 258                                                                     uint64_t),
 259
 260                                unsigned (*get_state_size)(void *, uint32_t),
 261                                void *user_data);
 262 void gen_batch_decode_ctx_finish(struct gen_batch_decode_ctx *ctx);
 263
 264
 265 void gen_print_batch(struct gen_batch_decode_ctx *ctx,
 266                      const uint32_t *batch, uint32_t batch_size,
 267                      uint64_t batch_addr, bool from_ring);
 268
 269 #ifdef __cplusplus
 270 }
 271 #endif
 272
 273
 274 #endif /* GEN_DECODER_H */