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 struct gen_field_iterator {
  76    struct gen_group *group;
  77    char name[128];
  78    char value[128];
  79    uint64_t raw_value;
  80    struct gen_group *struct_desc;
  81    const uint32_t *p;
  82    int p_bit; /**< bit offset into p */
  83    const uint32_t *p_end;
  84    int start_bit; /**< current field starts at this bit offset into p */
  85    int end_bit; /**< current field ends at this bit offset into p */
  86
  87    int array_iter;
  88
  89    struct gen_field *field;
  90    bool print_colors;
  91 };
  92
  93 struct gen_spec {
  94    uint32_t gen;
  95
  96    struct hash_table *commands;
  97    struct hash_table *structs;
  98    struct hash_table *registers_by_name;
  99    struct hash_table *registers_by_offset;
 100    struct hash_table *enums;
 101
 102    struct hash_table *access_cache;
 103 };
 104
 105 struct gen_group {
 106    struct gen_spec *spec;
 107    char *name;
 108
 109    struct gen_field *fields; /* linked list of fields */
 110    struct gen_field *dword_length_field; /* <instruction> specific */
 111
 112    uint32_t dw_length;
 113    uint32_t engine_mask; /* <instruction> specific */
 114    uint32_t bias; /* <instruction> specific */
 115    uint32_t array_offset; /* <group> specific */
 116    uint32_t array_count; /* number of elements, <group> specific */
 117    uint32_t array_item_size; /* <group> specific */
 118    bool variable; /* <group> specific */
 119    bool fixed_length; /* True for <struct> & <register> */
 120
 121    struct gen_group *parent;
 122    struct gen_group *next;
 123
 124    uint32_t opcode_mask;
 125    uint32_t opcode;
 126
 127    uint32_t register_offset; /* <register> specific */
 128 };
 129
 130 struct gen_value {
 131    char *name;
 132    uint64_t value;
 133 };
 134
 135 struct gen_enum {
 136    char *name;
 137    int nvalues;
 138    struct gen_value **values;
 139 };
 140
 141 struct gen_type {
 142    enum {
 143       GEN_TYPE_UNKNOWN,
 144       GEN_TYPE_INT,
 145       GEN_TYPE_UINT,
 146       GEN_TYPE_BOOL,
 147       GEN_TYPE_FLOAT,
 148       GEN_TYPE_ADDRESS,
 149       GEN_TYPE_OFFSET,
 150       GEN_TYPE_STRUCT,
 151       GEN_TYPE_UFIXED,
 152       GEN_TYPE_SFIXED,
 153       GEN_TYPE_MBO,
 154       GEN_TYPE_ENUM
 155    } kind;
 156
 157    /* Struct definition for  GEN_TYPE_STRUCT */
 158    union {
 159       struct gen_group *gen_struct;
 160       struct gen_enum *gen_enum;
 161       struct {
 162          /* Integer and fractional sizes for GEN_TYPE_UFIXED and GEN_TYPE_SFIXED */
 163          int i, f;
 164       };
 165    };
 166 };
 167
 168 union gen_field_value {
 169    bool b32;
 170    float f32;
 171    uint64_t u64;
 172    int64_t i64;
 173 };
 174
 175 struct gen_field {
 176    struct gen_group *parent;
 177    struct gen_field *next;
 178    struct gen_group *array;
 179
 180    char *name;
 181    int start, end;
 182    struct gen_type type;
 183    bool has_default;
 184    uint32_t default_value;
 185
 186    struct gen_enum inline_enum;
 187 };
 188
 189 void gen_field_iterator_init(struct gen_field_iterator *iter,
 190                              struct gen_group *group,
 191                              const uint32_t *p, int p_bit,
 192                              bool print_colors);
 193
 194 bool gen_field_iterator_next(struct gen_field_iterator *iter);
 195
 196 void gen_print_group(FILE *out,
 197                      struct gen_group *group,
 198                      uint64_t offset, const uint32_t *p, int p_bit,
 199                      bool color);
 200
 201 enum gen_batch_decode_flags {
 202    /** Print in color! */
 203    GEN_BATCH_DECODE_IN_COLOR  = (1 << 0),
 204    /** Print everything, not just headers */
 205    GEN_BATCH_DECODE_FULL      = (1 << 1),
 206    /** Print offsets along with the batch */
 207    GEN_BATCH_DECODE_OFFSETS   = (1 << 2),
 208    /** Guess when a value is a float and print it as such */
 209    GEN_BATCH_DECODE_FLOATS    = (1 << 3),
 210 };
 211
 212 struct gen_batch_decode_bo {
 213    uint64_t addr;
 214    uint32_t size;
 215    const void *map;
 216 };
 217
 218 struct gen_batch_decode_ctx {
 219    /**
 220     * Return information about the buffer containing the given address.
 221     *
 222     * If the given address is inside a buffer, the map pointer should be
 223     * offset accordingly so it points at the data corresponding to address.
 224     */
 225    struct gen_batch_decode_bo (*get_bo)(void *user_data, bool ppgtt, uint64_t address);
 226    unsigned (*get_state_size)(void *user_data,
 227                               uint32_t offset_from_dynamic_state_base_addr);
 228    void *user_data;
 229
 230    FILE *fp;
 231    struct gen_spec *spec;
 232    enum gen_batch_decode_flags flags;
 233
 234    struct gen_disasm *disasm;
 235
 236    uint64_t surface_base;
 237    uint64_t dynamic_base;
 238    uint64_t instruction_base;
 239
 240    int max_vbo_decoded_lines;
 241
 242    enum drm_i915_gem_engine_class engine;
 243
 244    int n_batch_buffer_start;
 245 };
 246
 247 void gen_batch_decode_ctx_init(struct gen_batch_decode_ctx *ctx,
 248                                const struct gen_device_info *devinfo,
 249                                FILE *fp, enum gen_batch_decode_flags flags,
 250                                const char *xml_path,
 251                                struct gen_batch_decode_bo (*get_bo)(void *,
 252                                                                     bool,
 253                                                                     uint64_t),
 254
 255                                unsigned (*get_state_size)(void *, uint32_t),
 256                                void *user_data);
 257 void gen_batch_decode_ctx_finish(struct gen_batch_decode_ctx *ctx);
 258
 259
 260 void gen_print_batch(struct gen_batch_decode_ctx *ctx,
 261                      const uint32_t *batch, uint32_t batch_size,
 262                      uint64_t batch_addr, bool from_ring);
 263
 264 #ifdef __cplusplus
 265 }
 266 #endif
 267
 268
 269 #endif /* GEN_DECODER_H */