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
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct gen_spec;
  39 struct gen_group;
  40 struct gen_field;
  41 union gen_field_value;
  42
  43 static inline uint32_t gen_make_gen(uint32_t major, uint32_t minor)
  44 {
  45    return (major << 8) | minor;
  46 }
  47
  48 struct gen_group *gen_spec_find_struct(struct gen_spec *spec, const char *name);
  49 struct gen_spec *gen_spec_load(const struct gen_device_info *devinfo);
  50 struct gen_spec *gen_spec_load_from_path(const struct gen_device_info *devinfo,
  51                                          const char *path);
  52 void gen_spec_destroy(struct gen_spec *spec);
  53 uint32_t gen_spec_get_gen(struct gen_spec *spec);
  54 struct gen_group *gen_spec_find_instruction(struct gen_spec *spec, const uint32_t *p);
  55 struct gen_group *gen_spec_find_register(struct gen_spec *spec, uint32_t offset);
  56 struct gen_group *gen_spec_find_register_by_name(struct gen_spec *spec, const char *name);
  57 struct gen_enum *gen_spec_find_enum(struct gen_spec *spec, const char *name);
  58
  59 int gen_group_get_length(struct gen_group *group, const uint32_t *p);
  60 const char *gen_group_get_name(struct gen_group *group);
  61 uint32_t gen_group_get_opcode(struct gen_group *group);
  62 struct gen_field *gen_group_find_field(struct gen_group *group, const char *name);
  63 struct gen_enum *gen_spec_find_enum(struct gen_spec *spec, const char *name);
  64
  65 bool gen_field_is_header(struct gen_field *field);
  66
  67 struct gen_field_iterator {
  68    struct gen_group *group;
  69    char name[128];
  70    char value[128];
  71    uint64_t raw_value;
  72    struct gen_group *struct_desc;
  73    const uint32_t *p;
  74    int p_bit; /**< bit offset into p */
  75    const uint32_t *p_end;
  76    int start_bit; /**< current field starts at this bit offset into p */
  77    int end_bit; /**< current field ends at this bit offset into p */
  78
  79    int group_iter;
  80
  81    struct gen_field *field;
  82    bool print_colors;
  83 };
  84
  85 struct gen_spec {
  86    uint32_t gen;
  87
  88    struct hash_table *commands;
  89    struct hash_table *structs;
  90    struct hash_table *registers_by_name;
  91    struct hash_table *registers_by_offset;
  92    struct hash_table *enums;
  93
  94    struct hash_table *access_cache;
  95 };
  96
  97 struct gen_group {
  98    struct gen_spec *spec;
  99    char *name;
 100
 101    struct gen_field *fields; /* linked list of fields */
 102
 103    uint32_t dw_length;
 104    uint32_t group_offset, group_count;
 105    uint32_t group_size;
 106    bool variable;
 107    bool fixed_length; /* True for <struct> & <register> */
 108
 109    struct gen_group *parent;
 110    struct gen_group *next;
 111
 112    uint32_t opcode_mask;
 113    uint32_t opcode;
 114
 115    /* Register specific */
 116    uint32_t register_offset;
 117 };
 118
 119 struct gen_value {
 120    char *name;
 121    uint64_t value;
 122 };
 123
 124 struct gen_enum {
 125    char *name;
 126    int nvalues;
 127    struct gen_value **values;
 128 };
 129
 130 struct gen_type {
 131    enum {
 132       GEN_TYPE_UNKNOWN,
 133       GEN_TYPE_INT,
 134       GEN_TYPE_UINT,
 135       GEN_TYPE_BOOL,
 136       GEN_TYPE_FLOAT,
 137       GEN_TYPE_ADDRESS,
 138       GEN_TYPE_OFFSET,
 139       GEN_TYPE_STRUCT,
 140       GEN_TYPE_UFIXED,
 141       GEN_TYPE_SFIXED,
 142       GEN_TYPE_MBO,
 143       GEN_TYPE_ENUM
 144    } kind;
 145
 146    /* Struct definition for  GEN_TYPE_STRUCT */
 147    union {
 148       struct gen_group *gen_struct;
 149       struct gen_enum *gen_enum;
 150       struct {
 151          /* Integer and fractional sizes for GEN_TYPE_UFIXED and GEN_TYPE_SFIXED */
 152          int i, f;
 153       };
 154    };
 155 };
 156
 157 union gen_field_value {
 158    bool b32;
 159    float f32;
 160    uint64_t u64;
 161    int64_t i64;
 162 };
 163
 164 struct gen_field {
 165    struct gen_group *parent;
 166    struct gen_field *next;
 167
 168    char *name;
 169    int start, end;
 170    struct gen_type type;
 171    bool has_default;
 172    uint32_t default_value;
 173
 174    struct gen_enum inline_enum;
 175 };
 176
 177 void gen_field_iterator_init(struct gen_field_iterator *iter,
 178                              struct gen_group *group,
 179                              const uint32_t *p, int p_bit,
 180                              bool print_colors);
 181
 182 bool gen_field_iterator_next(struct gen_field_iterator *iter);
 183
 184 void gen_print_group(FILE *out,
 185                      struct gen_group *group,
 186                      uint64_t offset, const uint32_t *p, int p_bit,
 187                      bool color);
 188
 189 enum gen_batch_decode_flags {
 190    /** Print in color! */
 191    GEN_BATCH_DECODE_IN_COLOR  = (1 << 0),
 192    /** Print everything, not just headers */
 193    GEN_BATCH_DECODE_FULL      = (1 << 1),
 194    /** Print offsets along with the batch */
 195    GEN_BATCH_DECODE_OFFSETS   = (1 << 2),
 196    /** Guess when a value is a float and print it as such */
 197    GEN_BATCH_DECODE_FLOATS    = (1 << 3),
 198 };
 199
 200 struct gen_batch_decode_bo {
 201    uint64_t addr;
 202    uint32_t size;
 203    const void *map;
 204 };
 205
 206 struct gen_disasm *disasm;
 207
 208 struct gen_batch_decode_ctx {
 209    struct gen_batch_decode_bo (*get_bo)(void *user_data,
 210                                         uint64_t base_address);
 211    void *user_data;
 212
 213    FILE *fp;
 214    struct gen_spec *spec;
 215    enum gen_batch_decode_flags flags;
 216
 217    struct gen_disasm *disasm;
 218
 219    struct gen_batch_decode_bo surface_base;
 220    struct gen_batch_decode_bo dynamic_base;
 221    struct gen_batch_decode_bo instruction_base;
 222 };
 223
 224 void gen_batch_decode_ctx_init(struct gen_batch_decode_ctx *ctx,
 225                                const struct gen_device_info *devinfo,
 226                                FILE *fp, enum gen_batch_decode_flags flags,
 227                                const char *xml_path,
 228                                struct gen_batch_decode_bo (*get_bo)(void *,
 229                                                                     uint64_t),
 230                                void *user_data);
 231 void gen_batch_decode_ctx_finish(struct gen_batch_decode_ctx *ctx);
 232
 233
 234 void gen_print_batch(struct gen_batch_decode_ctx *ctx,
 235                      const uint32_t *batch, uint32_t batch_size,
 236                      uint64_t batch_addr);
 237
 238 #ifdef __cplusplus
 239 }
 240 #endif
 241
 242
 243 #endif /* GEN_DECODER_H */