src/intel/common/gen_decoder.c

   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 #include <stdio.h>
  25 #include <stdbool.h>
  26 #include <stdint.h>
  27 #include <stdarg.h>
  28 #include <string.h>
  29 #include <expat.h>
  30 #include <inttypes.h>
  31 #include <zlib.h>
  32
  33 #include <util/macros.h>
  34 #include <util/ralloc.h>
  35
  36 #include "gen_decoder.h"
  37
  38 #include "isl/isl.h"
  39 #include "genxml/genX_xml.h"
  40
  41 #define XML_BUFFER_SIZE 4096
  42 #define MAX_VALUE_ITEMS 128
  43
  44 struct location {
  45    const char *filename;
  46    int line_number;
  47 };
  48
  49 struct parser_context {
  50    XML_Parser parser;
  51    int foo;
  52    struct location loc;
  53
  54    struct gen_group *group;
  55    struct gen_enum *enoom;
  56
  57    int n_values, n_allocated_values;
  58    struct gen_value **values;
  59
  60    struct gen_field *last_field;
  61
  62    struct gen_spec *spec;
  63 };
  64
  65 const char *
  66 gen_group_get_name(struct gen_group *group)
  67 {
  68    return group->name;
  69 }
  70
  71 uint32_t
  72 gen_group_get_opcode(struct gen_group *group)
  73 {
  74    return group->opcode;
  75 }
  76
  77 struct gen_group *
  78 gen_spec_find_struct(struct gen_spec *spec, const char *name)
  79 {
  80    struct hash_entry *entry = _mesa_hash_table_search(spec->structs,
  81                                                       name);
  82    return entry ? entry->data : NULL;
  83 }
  84
  85 struct gen_group *
  86 gen_spec_find_register(struct gen_spec *spec, uint32_t offset)
  87 {
  88    struct hash_entry *entry =
  89       _mesa_hash_table_search(spec->registers_by_offset,
  90                               (void *) (uintptr_t) offset);
  91    return entry ? entry->data : NULL;
  92 }
  93
  94 struct gen_group *
  95 gen_spec_find_register_by_name(struct gen_spec *spec, const char *name)
  96 {
  97    struct hash_entry *entry =
  98       _mesa_hash_table_search(spec->registers_by_name, name);
  99    return entry ? entry->data : NULL;
 100 }
 101
 102 struct gen_enum *
 103 gen_spec_find_enum(struct gen_spec *spec, const char *name)
 104 {
 105    struct hash_entry *entry = _mesa_hash_table_search(spec->enums,
 106                                                       name);
 107    return entry ? entry->data : NULL;
 108 }
 109
 110 uint32_t
 111 gen_spec_get_gen(struct gen_spec *spec)
 112 {
 113    return spec->gen;
 114 }
 115
 116 static void __attribute__((noreturn))
 117 fail(struct location *loc, const char *msg, ...)
 118 {
 119    va_list ap;
 120
 121    va_start(ap, msg);
 122    fprintf(stderr, "%s:%d: error: ",
 123            loc->filename, loc->line_number);
 124    vfprintf(stderr, msg, ap);
 125    fprintf(stderr, "\n");
 126    va_end(ap);
 127    exit(EXIT_FAILURE);
 128 }
 129
 130 static void
 131 get_group_offset_count(const char **atts, uint32_t *offset, uint32_t *count,
 132                        uint32_t *size, bool *variable)
 133 {
 134    for (int i = 0; atts[i]; i += 2) {
 135       char *p;
 136
 137       if (strcmp(atts[i], "count") == 0) {
 138          *count = strtoul(atts[i + 1], &p, 0);
 139          if (*count == 0)
 140             *variable = true;
 141       } else if (strcmp(atts[i], "start") == 0) {
 142          *offset = strtoul(atts[i + 1], &p, 0);
 143       } else if (strcmp(atts[i], "size") == 0) {
 144          *size = strtoul(atts[i + 1], &p, 0);
 145       }
 146    }
 147    return;
 148 }
 149
 150 static struct gen_group *
 151 create_group(struct parser_context *ctx,
 152              const char *name,
 153              const char **atts,
 154              struct gen_group *parent)
 155 {
 156    struct gen_group *group;
 157
 158    group = rzalloc(ctx->spec, struct gen_group);
 159    if (name)
 160       group->name = ralloc_strdup(group, name);
 161
 162    group->spec = ctx->spec;
 163    group->variable = false;
 164
 165    for (int i = 0; atts[i]; i += 2) {
 166       char *p;
 167       if (strcmp(atts[i], "length") == 0) {
 168          group->dw_length = strtoul(atts[i + 1], &p, 0);
 169       }
 170    }
 171
 172    if (parent) {
 173       group->parent = parent;
 174       get_group_offset_count(atts,
 175                              &group->group_offset,
 176                              &group->group_count,
 177                              &group->group_size,
 178                              &group->variable);
 179    }
 180
 181    return group;
 182 }
 183
 184 static struct gen_enum *
 185 create_enum(struct parser_context *ctx, const char *name, const char **atts)
 186 {
 187    struct gen_enum *e;
 188
 189    e = rzalloc(ctx->spec, struct gen_enum);
 190    if (name)
 191       e->name = ralloc_strdup(e, name);
 192
 193    return e;
 194 }
 195
 196 static void
 197 get_register_offset(const char **atts, uint32_t *offset)
 198 {
 199    for (int i = 0; atts[i]; i += 2) {
 200       char *p;
 201
 202       if (strcmp(atts[i], "num") == 0)
 203          *offset = strtoul(atts[i + 1], &p, 0);
 204    }
 205    return;
 206 }
 207
 208 static void
 209 get_start_end_pos(int *start, int *end)
 210 {
 211    /* start value has to be mod with 32 as we need the relative
 212     * start position in the first DWord. For the end position, add
 213     * the length of the field to the start position to get the
 214     * relative postion in the 64 bit address.
 215     */
 216    if (*end - *start > 32) {
 217       int len = *end - *start;
 218       *start = *start % 32;
 219       *end = *start + len;
 220    } else {
 221       *start = *start % 32;
 222       *end = *end % 32;
 223    }
 224
 225    return;
 226 }
 227
 228 static inline uint64_t
 229 mask(int start, int end)
 230 {
 231    uint64_t v;
 232
 233    v = ~0ULL >> (63 - end + start);
 234
 235    return v << start;
 236 }
 237
 238 static inline uint64_t
 239 field_value(uint64_t value, int start, int end)
 240 {
 241    get_start_end_pos(&start, &end);
 242    return (value & mask(start, end)) >> (start);
 243 }
 244
 245 static struct gen_type
 246 string_to_type(struct parser_context *ctx, const char *s)
 247 {
 248    int i, f;
 249    struct gen_group *g;
 250    struct gen_enum *e;
 251
 252    if (strcmp(s, "int") == 0)
 253       return (struct gen_type) { .kind = GEN_TYPE_INT };
 254    else if (strcmp(s, "uint") == 0)
 255       return (struct gen_type) { .kind = GEN_TYPE_UINT };
 256    else if (strcmp(s, "bool") == 0)
 257       return (struct gen_type) { .kind = GEN_TYPE_BOOL };
 258    else if (strcmp(s, "float") == 0)
 259       return (struct gen_type) { .kind = GEN_TYPE_FLOAT };
 260    else if (strcmp(s, "address") == 0)
 261       return (struct gen_type) { .kind = GEN_TYPE_ADDRESS };
 262    else if (strcmp(s, "offset") == 0)
 263       return (struct gen_type) { .kind = GEN_TYPE_OFFSET };
 264    else if (sscanf(s, "u%d.%d", &i, &f) == 2)
 265       return (struct gen_type) { .kind = GEN_TYPE_UFIXED, .i = i, .f = f };
 266    else if (sscanf(s, "s%d.%d", &i, &f) == 2)
 267       return (struct gen_type) { .kind = GEN_TYPE_SFIXED, .i = i, .f = f };
 268    else if (g = gen_spec_find_struct(ctx->spec, s), g != NULL)
 269       return (struct gen_type) { .kind = GEN_TYPE_STRUCT, .gen_struct = g };
 270    else if (e = gen_spec_find_enum(ctx->spec, s), e != NULL)
 271       return (struct gen_type) { .kind = GEN_TYPE_ENUM, .gen_enum = e };
 272    else if (strcmp(s, "mbo") == 0)
 273       return (struct gen_type) { .kind = GEN_TYPE_MBO };
 274    else
 275       fail(&ctx->loc, "invalid type: %s", s);
 276 }
 277
 278 static struct gen_field *
 279 create_field(struct parser_context *ctx, const char **atts)
 280 {
 281    struct gen_field *field;
 282
 283    field = rzalloc(ctx->group, struct gen_field);
 284    field->parent = ctx->group;
 285
 286    for (int i = 0; atts[i]; i += 2) {
 287       char *p;
 288
 289       if (strcmp(atts[i], "name") == 0)
 290          field->name = ralloc_strdup(field, atts[i + 1]);
 291       else if (strcmp(atts[i], "start") == 0)
 292          field->start = strtoul(atts[i + 1], &p, 0);
 293       else if (strcmp(atts[i], "end") == 0) {
 294          field->end = strtoul(atts[i + 1], &p, 0);
 295       } else if (strcmp(atts[i], "type") == 0)
 296          field->type = string_to_type(ctx, atts[i + 1]);
 297       else if (strcmp(atts[i], "default") == 0 &&
 298                field->start >= 16 && field->end <= 31) {
 299          field->has_default = true;
 300          field->default_value = strtoul(atts[i + 1], &p, 0);
 301       }
 302    }
 303
 304    return field;
 305 }
 306
 307 static struct gen_value *
 308 create_value(struct parser_context *ctx, const char **atts)
 309 {
 310    struct gen_value *value = rzalloc(ctx->values, struct gen_value);
 311
 312    for (int i = 0; atts[i]; i += 2) {
 313       if (strcmp(atts[i], "name") == 0)
 314          value->name = ralloc_strdup(value, atts[i + 1]);
 315       else if (strcmp(atts[i], "value") == 0)
 316          value->value = strtoul(atts[i + 1], NULL, 0);
 317    }
 318
 319    return value;
 320 }
 321
 322 static struct gen_field *
 323 create_and_append_field(struct parser_context *ctx,
 324                         const char **atts)
 325 {
 326    struct gen_field *field = create_field(ctx, atts);
 327    struct gen_field *prev = NULL, *list = ctx->group->fields;
 328
 329    while (list && field->start > list->start) {
 330       prev = list;
 331       list = list->next;
 332    }
 333
 334    field->next = list;
 335    if (prev == NULL)
 336       ctx->group->fields = field;
 337    else
 338       prev->next = field;
 339
 340    return field;
 341 }
 342
 343 static void
 344 start_element(void *data, const char *element_name, const char **atts)
 345 {
 346    struct parser_context *ctx = data;
 347    const char *name = NULL;
 348    const char *gen = NULL;
 349
 350    ctx->loc.line_number = XML_GetCurrentLineNumber(ctx->parser);
 351
 352    for (int i = 0; atts[i]; i += 2) {
 353       if (strcmp(atts[i], "name") == 0)
 354          name = atts[i + 1];
 355       else if (strcmp(atts[i], "gen") == 0)
 356          gen = atts[i + 1];
 357    }
 358
 359    if (strcmp(element_name, "genxml") == 0) {
 360       if (name == NULL)
 361          fail(&ctx->loc, "no platform name given");
 362       if (gen == NULL)
 363          fail(&ctx->loc, "no gen given");
 364
 365       int major, minor;
 366       int n = sscanf(gen, "%d.%d", &major, &minor);
 367       if (n == 0)
 368          fail(&ctx->loc, "invalid gen given: %s", gen);
 369       if (n == 1)
 370          minor = 0;
 371
 372       ctx->spec->gen = gen_make_gen(major, minor);
 373    } else if (strcmp(element_name, "instruction") == 0 ||
 374               strcmp(element_name, "struct") == 0) {
 375       ctx->group = create_group(ctx, name, atts, NULL);
 376    } else if (strcmp(element_name, "register") == 0) {
 377       ctx->group = create_group(ctx, name, atts, NULL);
 378       get_register_offset(atts, &ctx->group->register_offset);
 379    } else if (strcmp(element_name, "group") == 0) {
 380       struct gen_group *previous_group = ctx->group;
 381       while (previous_group->next)
 382          previous_group = previous_group->next;
 383
 384       struct gen_group *group = create_group(ctx, "", atts, ctx->group);
 385       previous_group->next = group;
 386       ctx->group = group;
 387    } else if (strcmp(element_name, "field") == 0) {
 388       ctx->last_field = create_and_append_field(ctx, atts);
 389    } else if (strcmp(element_name, "enum") == 0) {
 390       ctx->enoom = create_enum(ctx, name, atts);
 391    } else if (strcmp(element_name, "value") == 0) {
 392       if (ctx->n_values >= ctx->n_allocated_values) {
 393          ctx->n_allocated_values = MAX2(2, ctx->n_allocated_values * 2);
 394          ctx->values = reralloc_array_size(ctx->spec, ctx->values,
 395                                            sizeof(struct gen_value *),
 396                                            ctx->n_allocated_values);
 397       }
 398       assert(ctx->n_values < ctx->n_allocated_values);
 399       ctx->values[ctx->n_values++] = create_value(ctx, atts);
 400    }
 401
 402 }
 403
 404 static void
 405 end_element(void *data, const char *name)
 406 {
 407    struct parser_context *ctx = data;
 408    struct gen_spec *spec = ctx->spec;
 409
 410    if (strcmp(name, "instruction") == 0 ||
 411        strcmp(name, "struct") == 0 ||
 412        strcmp(name, "register") == 0) {
 413       struct gen_group *group = ctx->group;
 414       struct gen_field *list = group->fields;
 415
 416       ctx->group = ctx->group->parent;
 417
 418       while (list && list->end <= 31) {
 419          if (list->start >= 16 && list->has_default) {
 420             group->opcode_mask |=
 421                mask(list->start % 32, list->end % 32);
 422             group->opcode |= list->default_value << list->start;
 423          }
 424          list = list->next;
 425       }
 426
 427       if (strcmp(name, "instruction") == 0)
 428          _mesa_hash_table_insert(spec->commands, group->name, group);
 429       else if (strcmp(name, "struct") == 0)
 430          _mesa_hash_table_insert(spec->structs, group->name, group);
 431       else if (strcmp(name, "register") == 0) {
 432          _mesa_hash_table_insert(spec->registers_by_name, group->name, group);
 433          _mesa_hash_table_insert(spec->registers_by_offset,
 434                                  (void *) (uintptr_t) group->register_offset,
 435                                  group);
 436       }
 437    } else if (strcmp(name, "group") == 0) {
 438       ctx->group = ctx->group->parent;
 439    } else if (strcmp(name, "field") == 0) {
 440       struct gen_field *field = ctx->last_field;
 441       ctx->last_field = NULL;
 442       field->inline_enum.values = ctx->values;
 443       field->inline_enum.nvalues = ctx->n_values;
 444       ctx->values = ralloc_array(ctx->spec, struct gen_value*, ctx->n_allocated_values = 2);
 445       ctx->n_values = 0;
 446    } else if (strcmp(name, "enum") == 0) {
 447       struct gen_enum *e = ctx->enoom;
 448       e->values = ctx->values;
 449       e->nvalues = ctx->n_values;
 450       ctx->values = ralloc_array(ctx->spec, struct gen_value*, ctx->n_allocated_values = 2);
 451       ctx->n_values = 0;
 452       ctx->enoom = NULL;
 453       _mesa_hash_table_insert(spec->enums, e->name, e);
 454    }
 455 }
 456
 457 static void
 458 character_data(void *data, const XML_Char *s, int len)
 459 {
 460 }
 461
 462 static int
 463 devinfo_to_gen(const struct gen_device_info *devinfo)
 464 {
 465    int value = 10 * devinfo->gen;
 466
 467    if (devinfo->is_baytrail || devinfo->is_haswell)
 468       value += 5;
 469
 470    return value;
 471 }
 472
 473 static uint32_t zlib_inflate(const void *compressed_data,
 474                              uint32_t compressed_len,
 475                              void **out_ptr)
 476 {
 477    struct z_stream_s zstream;
 478    void *out;
 479
 480    memset(&zstream, 0, sizeof(zstream));
 481
 482    zstream.next_in = (unsigned char *)compressed_data;
 483    zstream.avail_in = compressed_len;
 484
 485    if (inflateInit(&zstream) != Z_OK)
 486       return 0;
 487
 488    out = malloc(4096);
 489    zstream.next_out = out;
 490    zstream.avail_out = 4096;
 491
 492    do {
 493       switch (inflate(&zstream, Z_SYNC_FLUSH)) {
 494       case Z_STREAM_END:
 495          goto end;
 496       case Z_OK:
 497          break;
 498       default:
 499          inflateEnd(&zstream);
 500          return 0;
 501       }
 502
 503       if (zstream.avail_out)
 504          break;
 505
 506       out = realloc(out, 2*zstream.total_out);
 507       if (out == NULL) {
 508          inflateEnd(&zstream);
 509          return 0;
 510       }
 511
 512       zstream.next_out = (unsigned char *)out + zstream.total_out;
 513       zstream.avail_out = zstream.total_out;
 514    } while (1);
 515  end:
 516    inflateEnd(&zstream);
 517    *out_ptr = out;
 518    return zstream.total_out;
 519 }
 520
 521 static uint32_t _hash_uint32(const void *key)
 522 {
 523    return (uint32_t) (uintptr_t) key;
 524 }
 525
 526 struct gen_spec *
 527 gen_spec_load(const struct gen_device_info *devinfo)
 528 {
 529    struct parser_context ctx;
 530    void *buf;
 531    uint8_t *text_data = NULL;
 532    uint32_t text_offset = 0, text_length = 0, total_length;
 533    uint32_t gen_10 = devinfo_to_gen(devinfo);
 534
 535    for (int i = 0; i < ARRAY_SIZE(genxml_files_table); i++) {
 536       if (genxml_files_table[i].gen_10 == gen_10) {
 537          text_offset = genxml_files_table[i].offset;
 538          text_length = genxml_files_table[i].length;
 539          break;
 540       }
 541    }
 542
 543    if (text_length == 0) {
 544       fprintf(stderr, "unable to find gen (%u) data\n", gen_10);
 545       return NULL;
 546    }
 547
 548    memset(&ctx, 0, sizeof ctx);
 549    ctx.parser = XML_ParserCreate(NULL);
 550    XML_SetUserData(ctx.parser, &ctx);
 551    if (ctx.parser == NULL) {
 552       fprintf(stderr, "failed to create parser\n");
 553       return NULL;
 554    }
 555
 556    XML_SetElementHandler(ctx.parser, start_element, end_element);
 557    XML_SetCharacterDataHandler(ctx.parser, character_data);
 558
 559    ctx.spec = rzalloc(NULL, struct gen_spec);
 560
 561    ctx.spec->commands =
 562       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 563    ctx.spec->structs =
 564       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 565    ctx.spec->registers_by_name =
 566       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 567    ctx.spec->registers_by_offset =
 568       _mesa_hash_table_create(ctx.spec, _hash_uint32, _mesa_key_pointer_equal);
 569    ctx.spec->enums =
 570       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 571
 572    ctx.spec->access_cache =
 573       _mesa_hash_table_create(ctx.spec, _mesa_hash_string, _mesa_key_string_equal);
 574
 575    total_length = zlib_inflate(compress_genxmls,
 576                                sizeof(compress_genxmls),
 577                                (void **) &text_data);
 578    assert(text_offset + text_length <= total_length);
 579
 580    buf = XML_GetBuffer(ctx.parser, text_length);
 581    memcpy(buf, &text_data[text_offset], text_length);
 582
 583    if (XML_ParseBuffer(ctx.parser, text_length, true) == 0) {
 584       fprintf(stderr,
 585               "Error parsing XML at line %ld col %ld byte %ld/%u: %s\n",
 586               XML_GetCurrentLineNumber(ctx.parser),
 587               XML_GetCurrentColumnNumber(ctx.parser),
 588               XML_GetCurrentByteIndex(ctx.parser), text_length,
 589               XML_ErrorString(XML_GetErrorCode(ctx.parser)));
 590       XML_ParserFree(ctx.parser);
 591       free(text_data);
 592       return NULL;
 593    }
 594
 595    XML_ParserFree(ctx.parser);
 596    free(text_data);
 597
 598    return ctx.spec;
 599 }
 600
 601 struct gen_spec *
 602 gen_spec_load_from_path(const struct gen_device_info *devinfo,
 603                         const char *path)
 604 {
 605    struct parser_context ctx;
 606    size_t len, filename_len = strlen(path) + 20;
 607    char *filename = malloc(filename_len);
 608    void *buf;
 609    FILE *input;
 610
 611    len = snprintf(filename, filename_len, "%s/gen%i.xml",
 612                   path, devinfo_to_gen(devinfo));
 613    assert(len < filename_len);
 614
 615    input = fopen(filename, "r");
 616    if (input == NULL) {
 617       fprintf(stderr, "failed to open xml description\n");
 618       free(filename);
 619       return NULL;
 620    }
 621
 622    memset(&ctx, 0, sizeof ctx);
 623    ctx.parser = XML_ParserCreate(NULL);
 624    XML_SetUserData(ctx.parser, &ctx);
 625    if (ctx.parser == NULL) {
 626       fprintf(stderr, "failed to create parser\n");
 627       fclose(input);
 628       free(filename);
 629       return NULL;
 630    }
 631
 632    XML_SetElementHandler(ctx.parser, start_element, end_element);
 633    XML_SetCharacterDataHandler(ctx.parser, character_data);
 634    ctx.loc.filename = filename;
 635    ctx.spec = rzalloc(NULL, struct gen_spec);
 636
 637    do {
 638       buf = XML_GetBuffer(ctx.parser, XML_BUFFER_SIZE);
 639       len = fread(buf, 1, XML_BUFFER_SIZE, input);
 640       if (len == 0) {
 641          fprintf(stderr, "fread: %m\n");
 642          free(ctx.spec);
 643          ctx.spec = NULL;
 644          goto end;
 645       }
 646       if (XML_ParseBuffer(ctx.parser, len, len == 0) == 0) {
 647          fprintf(stderr,
 648                  "Error parsing XML at line %ld col %ld: %s\n",
 649                  XML_GetCurrentLineNumber(ctx.parser),
 650                  XML_GetCurrentColumnNumber(ctx.parser),
 651                  XML_ErrorString(XML_GetErrorCode(ctx.parser)));
 652          free(ctx.spec);
 653          ctx.spec = NULL;
 654          goto end;
 655       }
 656    } while (len > 0);
 657
 658  end:
 659    XML_ParserFree(ctx.parser);
 660
 661    fclose(input);
 662    free(filename);
 663
 664    return ctx.spec;
 665 }
 666
 667 void gen_spec_destroy(struct gen_spec *spec)
 668 {
 669    ralloc_free(spec);
 670 }
 671
 672 struct gen_group *
 673 gen_spec_find_instruction(struct gen_spec *spec, const uint32_t *p)
 674 {
 675    struct hash_entry *entry;
 676
 677    hash_table_foreach(spec->commands, entry) {
 678       struct gen_group *command = entry->data;
 679       uint32_t opcode = *p & command->opcode_mask;
 680       if (opcode == command->opcode)
 681          return command;
 682    }
 683
 684    return NULL;
 685 }
 686
 687 struct gen_field *
 688 gen_group_find_field(struct gen_group *group, const char *name)
 689 {
 690    char path[256];
 691    snprintf(path, sizeof(path), "%s/%s", group->name, name);
 692
 693    struct gen_spec *spec = group->spec;
 694    struct hash_entry *entry = _mesa_hash_table_search(spec->access_cache,
 695                                                       path);
 696    if (entry)
 697       return entry->data;
 698
 699    struct gen_field *field = group->fields;
 700    while (field) {
 701       if (strcmp(field->name, name) == 0) {
 702          _mesa_hash_table_insert(spec->access_cache,
 703                                  ralloc_strdup(spec, path),
 704                                  field);
 705          return field;
 706       }
 707       field = field->next;
 708    }
 709
 710    return NULL;
 711 }
 712
 713 int
 714 gen_group_get_length(struct gen_group *group, const uint32_t *p)
 715 {
 716    uint32_t h = p[0];
 717    uint32_t type = field_value(h, 29, 31);
 718
 719    switch (type) {
 720    case 0: /* MI */ {
 721       uint32_t opcode = field_value(h, 23, 28);
 722       if (opcode < 16)
 723          return 1;
 724       else
 725          return field_value(h, 0, 7) + 2;
 726       break;
 727    }
 728
 729    case 2: /* BLT */ {
 730       return field_value(h, 0, 7) + 2;
 731    }
 732
 733    case 3: /* Render */ {
 734       uint32_t subtype = field_value(h, 27, 28);
 735       uint32_t opcode = field_value(h, 24, 26);
 736       uint16_t whole_opcode = field_value(h, 16, 31);
 737       switch (subtype) {
 738       case 0:
 739          if (whole_opcode == 0x6104 /* PIPELINE_SELECT_965 */)
 740             return 1;
 741          else if (opcode < 2)
 742             return field_value(h, 0, 7) + 2;
 743          else
 744             return -1;
 745       case 1:
 746          if (opcode < 2)
 747             return 1;
 748          else
 749             return -1;
 750       case 2: {
 751          if (opcode == 0)
 752             return field_value(h, 0, 7) + 2;
 753          else if (opcode < 3)
 754             return field_value(h, 0, 15) + 2;
 755          else
 756             return -1;
 757       }
 758       case 3:
 759          if (whole_opcode == 0x780b)
 760             return 1;
 761          else if (opcode < 4)
 762             return field_value(h, 0, 7) + 2;
 763          else
 764             return -1;
 765       }
 766    }
 767    }
 768
 769    return -1;
 770 }
 771
 772 static const char *
 773 gen_get_enum_name(struct gen_enum *e, uint64_t value)
 774 {
 775    for (int i = 0; i < e->nvalues; i++) {
 776       if (e->values[i]->value == value) {
 777          return e->values[i]->name;
 778       }
 779    }
 780    return NULL;
 781 }
 782
 783 static bool
 784 iter_more_fields(const struct gen_field_iterator *iter)
 785 {
 786    return iter->field != NULL && iter->field->next != NULL;
 787 }
 788
 789 static uint32_t
 790 iter_group_offset_bits(const struct gen_field_iterator *iter,
 791                        uint32_t group_iter)
 792 {
 793    return iter->group->group_offset + (group_iter * iter->group->group_size);
 794 }
 795
 796 static bool
 797 iter_more_groups(const struct gen_field_iterator *iter)
 798 {
 799    if (iter->group->variable) {
 800       return iter_group_offset_bits(iter, iter->group_iter + 1) <
 801               (gen_group_get_length(iter->group, iter->p) * 32);
 802    } else {
 803       return (iter->group_iter + 1) < iter->group->group_count ||
 804          iter->group->next != NULL;
 805    }
 806 }
 807
 808 static void
 809 iter_advance_group(struct gen_field_iterator *iter)
 810 {
 811    if (iter->group->variable)
 812       iter->group_iter++;
 813    else {
 814       if ((iter->group_iter + 1) < iter->group->group_count) {
 815          iter->group_iter++;
 816       } else {
 817          iter->group = iter->group->next;
 818          iter->group_iter = 0;
 819       }
 820    }
 821
 822    iter->field = iter->group->fields;
 823 }
 824
 825 static bool
 826 iter_advance_field(struct gen_field_iterator *iter)
 827 {
 828    if (iter_more_fields(iter)) {
 829       iter->field = iter->field->next;
 830    } else {
 831       if (!iter_more_groups(iter))
 832          return false;
 833
 834       iter_advance_group(iter);
 835    }
 836
 837    if (iter->field->name)
 838       strncpy(iter->name, iter->field->name, sizeof(iter->name));
 839    else
 840       memset(iter->name, 0, sizeof(iter->name));
 841
 842    int group_member_offset = iter_group_offset_bits(iter, iter->group_iter);
 843
 844    iter->start_bit = group_member_offset + iter->field->start;
 845    iter->end_bit = group_member_offset + iter->field->end;
 846    iter->struct_desc = NULL;
 847
 848    return true;
 849 }
 850
 851 static bool
 852 iter_decode_field_raw(struct gen_field_iterator *iter, uint64_t *qw)
 853 {
 854    *qw = 0;
 855
 856    int field_start = iter->p_bit + iter->start_bit;
 857    int field_end = iter->p_bit + iter->end_bit;
 858
 859    const uint32_t *p = iter->p + (iter->start_bit / 32);
 860    if (iter->p_end && p >= iter->p_end)
 861       return false;
 862
 863    if ((field_end - field_start) > 32) {
 864       if (!iter->p_end || (p + 1) < iter->p_end)
 865          *qw = ((uint64_t) p[1]) << 32;
 866       *qw |= p[0];
 867    } else
 868       *qw = p[0];
 869
 870    *qw = field_value(*qw, field_start, field_end);
 871
 872    /* Address & offset types have to be aligned to dwords, their start bit is
 873     * a reminder of the alignment requirement.
 874     */
 875    if (iter->field->type.kind == GEN_TYPE_ADDRESS ||
 876        iter->field->type.kind == GEN_TYPE_OFFSET)
 877       *qw <<= field_start % 32;
 878
 879    return true;
 880 }
 881
 882 static bool
 883 iter_decode_field(struct gen_field_iterator *iter)
 884 {
 885    union {
 886       uint64_t qw;
 887       float f;
 888    } v;
 889
 890    if (iter->field->name)
 891       strncpy(iter->name, iter->field->name, sizeof(iter->name));
 892    else
 893       memset(iter->name, 0, sizeof(iter->name));
 894
 895    memset(&v, 0, sizeof(v));
 896
 897    if (!iter_decode_field_raw(iter, &iter->raw_value))
 898       return false;
 899
 900    const char *enum_name = NULL;
 901
 902    v.qw = iter->raw_value;
 903    switch (iter->field->type.kind) {
 904    case GEN_TYPE_UNKNOWN:
 905    case GEN_TYPE_INT: {
 906       snprintf(iter->value, sizeof(iter->value), "%"PRId64, v.qw);
 907       enum_name = gen_get_enum_name(&iter->field->inline_enum, v.qw);
 908       break;
 909    }
 910    case GEN_TYPE_UINT: {
 911       snprintf(iter->value, sizeof(iter->value), "%"PRIu64, v.qw);
 912       enum_name = gen_get_enum_name(&iter->field->inline_enum, v.qw);
 913       break;
 914    }
 915    case GEN_TYPE_BOOL: {
 916       const char *true_string =
 917          iter->print_colors ? "\e[0;35mtrue\e[0m" : "true";
 918       snprintf(iter->value, sizeof(iter->value), "%s",
 919                v.qw ? true_string : "false");
 920       break;
 921    }
 922    case GEN_TYPE_FLOAT:
 923       snprintf(iter->value, sizeof(iter->value), "%f", v.f);
 924       break;
 925    case GEN_TYPE_ADDRESS:
 926    case GEN_TYPE_OFFSET:
 927       snprintf(iter->value, sizeof(iter->value), "0x%08"PRIx64, v.qw);
 928       break;
 929    case GEN_TYPE_STRUCT:
 930       snprintf(iter->value, sizeof(iter->value), "<struct %s>",
 931                iter->field->type.gen_struct->name);
 932       iter->struct_desc =
 933          gen_spec_find_struct(iter->group->spec,
 934                               iter->field->type.gen_struct->name);
 935       break;
 936    case GEN_TYPE_UFIXED:
 937       snprintf(iter->value, sizeof(iter->value), "%f",
 938                (float) v.qw / (1 << iter->field->type.f));
 939       break;
 940    case GEN_TYPE_SFIXED:
 941       /* FIXME: Sign extend extracted field. */
 942       snprintf(iter->value, sizeof(iter->value), "%s", "foo");
 943       break;
 944    case GEN_TYPE_MBO:
 945        break;
 946    case GEN_TYPE_ENUM: {
 947       snprintf(iter->value, sizeof(iter->value), "%"PRId64, v.qw);
 948       enum_name = gen_get_enum_name(iter->field->type.gen_enum, v.qw);
 949       break;
 950    }
 951    }
 952
 953    if (strlen(iter->group->name) == 0) {
 954       int length = strlen(iter->name);
 955       snprintf(iter->name + length, sizeof(iter->name) - length,
 956                "[%i]", iter->group_iter);
 957    }
 958
 959    if (enum_name) {
 960       int length = strlen(iter->value);
 961       snprintf(iter->value + length, sizeof(iter->value) - length,
 962                " (%s)", enum_name);
 963    } else if (strcmp(iter->name, "Surface Format") == 0) {
 964       if (isl_format_is_valid((enum isl_format)v.qw)) {
 965          const char *fmt_name = isl_format_get_name((enum isl_format)v.qw);
 966          int length = strlen(iter->value);
 967          snprintf(iter->value + length, sizeof(iter->value) - length,
 968                   " (%s)", fmt_name);
 969       }
 970    }
 971
 972    return true;
 973 }
 974
 975 void
 976 gen_field_iterator_init(struct gen_field_iterator *iter,
 977                         struct gen_group *group,
 978                         const uint32_t *p, int p_bit,
 979                         bool print_colors)
 980 {
 981    memset(iter, 0, sizeof(*iter));
 982
 983    iter->group = group;
 984    if (group->fields)
 985       iter->field = group->fields;
 986    else
 987       iter->field = group->next->fields;
 988    iter->p = p;
 989    iter->p_bit = p_bit;
 990
 991    int length = gen_group_get_length(iter->group, iter->p);
 992    iter->p_end = length > 0 ? &p[length] : NULL;
 993    iter->print_colors = print_colors;
 994
 995    bool result = iter_decode_field(iter);
 996    if (length >= 0)
 997       assert(result);
 998 }
 999
1000 bool
1001 gen_field_iterator_next(struct gen_field_iterator *iter)
1002 {
1003    if (!iter_advance_field(iter))
1004       return false;
1005
1006    if (!iter_decode_field(iter))
1007       return false;
1008
1009    return true;
1010 }
1011
1012 static void
1013 print_dword_header(FILE *outfile,
1014                    struct gen_field_iterator *iter,
1015                    uint64_t offset, uint32_t dword)
1016 {
1017    fprintf(outfile, "0x%08"PRIx64":  0x%08x : Dword %d\n",
1018            offset + 4 * dword, iter->p[dword], dword);
1019 }
1020
1021 bool
1022 gen_field_is_header(struct gen_field *field)
1023 {
1024    uint32_t bits;
1025
1026    if (field->start >= 32)
1027       return false;
1028
1029    bits = (1U << (field->end - field->start + 1)) - 1;
1030    bits <<= field->start;
1031
1032    return (field->parent->opcode_mask & bits) != 0;
1033 }
1034
1035 void
1036 gen_print_group(FILE *outfile, struct gen_group *group, uint64_t offset,
1037                 const uint32_t *p, int p_bit, bool color)
1038 {
1039    struct gen_field_iterator iter;
1040    int last_dword = -1;
1041
1042    gen_field_iterator_init(&iter, group, p, p_bit, color);
1043    do {
1044       int iter_dword = iter.end_bit / 32;
1045       if (last_dword != iter_dword) {
1046          for (int i = last_dword + 1; i <= iter_dword; i++)
1047             print_dword_header(outfile, &iter, offset, i);
1048          last_dword = iter_dword;
1049       }
1050       if (!gen_field_is_header(iter.field)) {
1051          fprintf(outfile, "    %s: %s\n", iter.name, iter.value);
1052          if (iter.struct_desc) {
1053             uint64_t struct_offset = offset + 4 * iter_dword;
1054             gen_print_group(outfile, iter.struct_desc, struct_offset,
1055                             &p[iter_dword], iter.start_bit % 32, color);
1056          }
1057       }
1058    } while (gen_field_iterator_next(&iter));
1059 }